_stords()
 Assign a date value to a referenced variable using a date string
------------------------------------------------------------------------------
 C Prototype

     #include "extend.api"
     int _stords(
                  char far * fpString,
                  int iParamNum
                  [, int iArrayIndex]
                )

 Arguments

     fpString is a far pointer to a null-terminated string representing
     the date value to be assigned.  The string must have the form yyyymmdd.

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

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

 Returns

     _stords() returns one if the function is successful; otherwise, it
     returns zero.

 Description

     _stords() stores a date value to a variable passed by reference as a
     parameter from CA-Clipper.  If the parameter specified by iParamNum is
     not passed by reference, _stords() ignores the call and returns a value
     of zero.

     _stords() converts the supplied string into a date value.  If you supply
     a string that does not represent a valid date, a blank date value will
     be stored.

     Note:  _stords() converts the supplied string into a date value.
     The string need not be preserved after the call to _stords().

 Examples

     .  From C:

        _stords("19991231", 1);

     .  From Assembly language:

        EXTRN __stords:FAR
              mov   ax, 1                ; iParamNum
              push  ax
              mov   dx, seg MyString     ; pass address of string
                                         ; (creation of string not shown)
              mov   ax, offset MyString
              push  dx
              push  ax
              call  __stords
              add   sp, 6                ; reset stack pointer

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