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

 _errPutDescription()
 Set the value of description
------------------------------------------------------------------------------
 C Prototype

     #include "error.api"
     ERRORP _errPutDescription(
                                ERRORP pError,
                                BYTEP  fpDescription
                              )

 Arguments

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

     fpDescription is a pointer to a null-terminated string containing a
     short description of the specific error.

 Returns

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

 Description

     _errPutDescription() defines a short error description that is displayed
     by the default CA-Clipper Error Handler routine to give the user an
     indication of the problem.  The message should correspond to the general
     problem (genCode), not the specific failure (subCode).  "Open error" or
     "Argument Error" are typical of description messages.

     Note:  If you use one of the genCodes defined in Error.ch (such as
     EG_OPEN), you do not have to supply a description.  The proper
     description will be used automatically when the error is launched.

 Examples

     .  This code fragment shows the setting of description (you
        should try to be more descriptive than the example):

        #include "error.api"
           .
           .
           .
           _errPutDescription( pError, "Something happened" );
           uiErrCode = _errLaunch( pError );
           .
           .
           .

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