wcGetVariable( )

Gets the value of a particular variable.

Example

returnCode = wcGetVariable(cntrlHandle, "$customerSelection", &product);

int wcGetVariable(void *controlHandle, 
                  char *varName,
                  char **currentValue)

controlHandle	The handle to the control structure.
varName	Name of the variable for which you want to get the value.
currentValue	Out parameter used to return a pointer to the data associated with the specified varName.

0	Success.
Error code	Failure or exception. For a list of possible error codes, see Error Messages.

All variables are accessible to wcGetVariable( ). For example, the variable can be an environment variable, a parameter in the configuration file, a variable passed to the application from an HTML form, a variable set through wcSetVariable( ), a variable passed as a parameter to WebExplode( ), a variable set as a side effect of some operation such as an MISQL tag, or a variable from an MIVAR tag.

The following code shows how wcGetVariable( ) is used in an application.


    wcGetVariable(wcp, "$MIval", &mival);

    if (mival==NULL)
        wcSetVariable(wcp, "$MIval", "firstpage");