[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 _errGetFileName()
 Get the filename
------------------------------------------------------------------------------
 C Prototype

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

 Arguments

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

 Returns

     _errGetFileName() returns a pointer to the string containing the
     filename.

 Description

     _errGetFileName() retrieves a pointer to a string containing the name of
     the file being operated on, if any, when the error occurred.  This value
     should be empty for operations that do not involve files.

     Note:  The _fsExtOpen() function automatically sets filename to the
     correct value, if an error occurs.  See the "File System API Reference"
     chapter in this guide and the Usage Example at the end of this chapter
     for more information.

 Examples

     .  This code fragment retrieves a pointer to the string filename:

        #include "error.api"
           .
           .
           .
           BYTEP fpFileName;
           fpFileName = _errGetFileName( pError );
           .
           .
           .

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


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