PA_Dial4DSaveVariables


version 2003


PA_Dial4DSaveVariables (dialog) → void*

Parameter Type Description
dialog PA_Dial4D Dialog reference
Function result void* Pointer to the dialog context

Description

The routine PA_Dial4DSaveVariables returns a pointer to the dialog context referenced by dialog .

Dialogs use their own variable context. If you want to access the current process variables, you must switch from dialog variables to current process variables. This is done using PA_Dial4DSaveVariables . Once the process variables have been accessed, the plug-in MUST counter balance the previous call to PA_Dial4DSaveVariables by a call to PA_Dial4DRestoreVariables (passing it the value returned by PA_Dial4DSaveVariables ) to switch back from process variables to dialog variables.

Example

Sample use of the two routines :

   char   *toDialogContext;
   PA_Variable var;
 
    toDialogContext = (char *) PA_Dial4DSaveVariables();
   /* . . . access process variables . . . */
   var = PA_GetVariable( "aVariable" );
   PA_Dial4DRestoreVariables( toDialogContext );

See Also

PA_Dial4DRestoreVariables , PA_GetVariable .

Error Handling

None.