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

 _errGetDescription()
 Get the value of description
------------------------------------------------------------------------------
 C Prototype

     #include "error.api"
     BYTEP _errGetDescription(
                               ERRORP pError
                             )

 Arguments

     pError is a pointer to the Error object from which the value is to
     be retrieved.

 Returns

     _errGetDescription() returns a pointer to the string containing the
     error description.

 Description

     _errGetDescription() retrieves a pointer to the description string of an
     error.  The description is a short error message that is displayed by
     the default CA-Clipper Error Handler routine to give the user an
     indication of the problem.

     Note:  This string may be empty if the genCode is defined in
     Error.ch (such as EG_OPEN).  In this case, the proper description will
     automatically be supplied when the error is launched.

 Examples

     .  This code fragment retrieves a pointer to the error
        description:

        #include "error.api"
           .
           .
           .
           BYTEP fpDescription;
           fpDescription = _errGetDescription( pError );
           .
           .
           .

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