Click above to get retro games delivered to your door ever month!

 _errPutSubCode()
 Set the value of subCode
------------------------------------------------------------------------------
 C Prototype

     #include "error.api"
     ERRORP _errPutSubCode(
                            ERRORP pError,
                            USHORT uiSubCode
                          )

 Arguments

     pError is a pointer to the Error object that is to be set.

     uiSubCode is a value indicating the specific error number within the
     subsystem referenced by subSystem.

 Returns

     _errPutSubCode() returns a pointer to the Error object (self).

 Description

     _errPutSubCode() allows the assignment of a subCode to an error.  It is
     the combination of the subSystem name and the subCode that uniquely
     identifies a specific error.

     You should make subCodes consistent between subsystems that are
     identical in functionality.  For example, the CA-Clipper DBFNTX and
     DBFNDX share the same subCodes wherever possible.  Designers of RDD
     subsystems should attempt to use the same subCodes as the CA-Clipper
     RDDs in order to provide consistency to the end user.

 Examples

     .  This code fragment shows the setting of subCode:

        #include "error.api"

           .
           .
           .
           _errPutSubCode( pError, 1210 );
           uiErrCode = _errLaunch( pError );
           .
           .
           .

 Files:  Library is CLIPPER.LIB, header file is Error.api.