Functions and Directives Functions and Directives

Function _stor() Foundation

Assigns the value NIL to a parameter.

Syntax
BOOL _stor(XppParamList pList, ULONG ulIndex, ...);
Parameters
XppParamList pList
Pointer to the Xbase++ parameter list, which is used to provide access to the parameter.
ULONG ulIndex
Position of the parameter which is to be changed (first parameter is 1).
...
The remaining arguments are only considered when the specified parameter is an array. They must be of ULONG type. To select an element of the array an index is specified for each array dimension. If the array value itself should be replaced, NULL must be specified as the first value. Note:The end of the array index list must be indicated by incorporating a NULL as the last value in the list.
Return

Always returns TRUE.

Description

_stor() is used to set the value of a parameter to NIL. The new value is only returned to Xbase++ when the parameter was passed by reference. But further checks of the parameter from within the C function by the _par functions show the new value regardless of how it was passed.

Examples
/* 
Sets a parameter to NIL. 
*/ 
#include <xpppar.h> 

_stor(<pList>, 1, 0);
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.