LogMessages Method (ERROR)
10.1, PLBCMP GUI Only
The LogMessages method invokes error logging. This method uses the following format:
|
|
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. An ERROR object that has been previously declared.
return
Optional. A Numeric Variable that returns zero when the method executes successfully. A non-zero value is returned when the method fails.
filename
Required. A Character String Variable or string literal that specifies the file name to be used for error logging.
flags
Optional. A Numeric Variable that specifies a bit mask value that controls the behaviors of this method.
Flags Affected: EOS, OVER, ZERO
Note the following:
The ZERO flag is set if the {return} value is zero.
The OVER flag is set if the returned value overflows the {return} Numeric Variable.
The EOS flag is always set to FALSE.
The {return} values are described as follows:
|
Value |
Behavior |
|
0 |
The method executed successfully. |
|
1 |
The method failed because there was no {filename} specified. |
|
2 |
The method failed because there was an error resetting the {filename}. |
The {flags} bit mask values are described as follows:
|
Value |
Keyword |
Behavior |
|
0x1 |
ERRLOGON |
Turn on all logging and log all errors that have not been logged. |
|
0x2 |
ERRLOGOFF |
Turn logging off. |
|
0x4 |
ERRLOGRESET |
Reset the log file to a file size of zero bytes. |
See Also: Method Syntax, ERROR Methods
|
|