Function PPGetMessage() Professional

Returns the textual description of an error code

Syntax
PPGetMessage( <nError> ) --> cMessage
Parameters
<nError>
<nError> is the numerical error code returned by a function of the PreProcessor-API.
Return

The return value of PPGetMessage() is a character string.

Description

The function PPGetMessage() retrieves the textual description of an error code caused by the PreProcessor-API. The error texts are either specific errors of the PreProcessor-API (see xpppp.ch), errors of the Xbase++-Runtime system (see error.ch) or operating system errors.

Examples
Show error message
// This sample shows how to use PPGetMessage() 
#include "xpppp.ch" 
#pragma library("aspapib.lib") 

PROCEDURE Main 
LOCAL nError 
LOCAL cInput, cOutput 
      
      nError := PreprocessorInstall("std.ch") 
      IF nError != XPP_ERR_NONE 
           ? PPGetMessage(nError) 
           QUIT 
      ENDIF 
      // pass errornous #define 
      cInput := "#define 1" 
      nError := PreProcessLine(cInput, @cOutput) 
      IF nError != XPP_ERR_NONE 
           // print error 
           ? cInput +": "+PPGetMessage(nError) 
      ENDIF         
      PreprocessorUninstall() 
RETURN 
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.