[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 _parl()
 Retrieve a logical parameter as an integer
------------------------------------------------------------------------------
 C Prototype

     #include "extend.api"
     int _parl(
                 int iParamNum
                 [, int iArrayIndex]
              )

 Arguments

     iParamNum is the one-based ordinal position of the parameter in the
     parameter list.

     iArrayIndex is an array index that specifies a particular element if
     the iParamNum parameter is an array.

 Returns

     _parl() returns an int type value where one represents true (.T.) and
     zero represents false (.F.).

 Description

     _parl() retrieves a logical value passed as a parameter from CA-Clipper.
     If the specified CA-Clipper parameter was true (.T.), _parl() returns
     one; otherwise, it returns zero.

 Examples

     .  From C:

        int log;
        log = _parl(1);

     .  From Assembly language:

        EXTRN __parl:FAR
              mov   ax, 1
              push  ax
              call  __parl            ; value returned in AX
              add   sp, 2             ; reset stack pointer

 Files  Library is CLIPPER.LIB, header file is Extend.api.


See Also: _retl() _storl()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson