Functions and Directives Functions and Directives

Function _parl() Foundation

Determines the value of a logical parameter.

Syntax
BOOL _parl(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 contains the logical value (first parameter is 1).
...
The remaining arguments must be of ULONG type and are only considered when the parameter <ulIndex> is an array. In this case, an index is specified for each array dimension to select the element which has the logical value. Note:The end of the array index list must be indicated by incorporating a NULL as the last value in the list.
Return

Returns TRUE (= 1) or FALSE (= 0). When the parameter does not contain a logical value, FALSE is returned.

Description

_parl() is used to read a logical value from a parameter.

Examples
/* 
Reads a logical value from a parameter. 
*/ 
#include <xpppar.h> 

BOOL logic; 
                             /* Is parameter 4 a logical value ? */ 
if ( XPP_IS_LOGIC( _partype(<pList>, 4) ) ) 
{ 
logic = _parl(<pList>, 4);   /* OK, read */ 
}
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.