Function PreprocessorInstall() Professional

Installs the PreProcessor

Syntax
PreProcessorInstall( [<cStdchFileName>] ) --> nErrNum
Parameters
<cStdchFileName>
<cStdchFileName> determines the initial command file like 'std.ch'. All directories listed in the SET INCLUDE= environment variable are searched. If not passed no command file is used.
Return

The return value of PreprocessorInstall() is is a numerical value indicating the success or error of the function. If no error occured, the returned value is XPP_ERR_NONE. Error numbers are defined in xpppp.ch. To retrieve the error message, use PPGetMessage().

Description

The function PreprocessorInstall() must be called before any other function of the PreProcessor-API can be called. The passed parameter is the name of a command file (ch-file) including default commands, translates or defines. A typical command file is std.ch. There is only one PreProcessor-API active at the same time for one application process, but it can be used shared among different threads.

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.