[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 _parc()
 Retrieve a character parameter
------------------------------------------------------------------------------
 C Prototype

     #include "extend.api"
     char * _parc(
                   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

     _parc() returns a far pointer to a series of bytes that represent the
     character value.

 Description

     _parc() retrieves a character value passed as a parameter from
     CA-Clipper.

     The pointer returned by _parc() may or may not point to the actual
     character value passed from CA-Clipper.  In some cases, the pointer will
     point to a copy of the actual value.  In other cases, it will point to
     an internal value that is shared by more than one CA-Clipper variable.

     The pointer returned from _parc() should not directly modify the
     character value, since this can produce unpredictable results.  To
     modify a character value, use _retc() returning a modified copy of the
     value or passing the associated CA-Clipper parameter by reference; then
     use _storc() to modify it.

 Examples

     .  From C:

        char *str;
        str = _parc(1);

     .  From Assembly language:

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

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


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