GetMessage Method (ERROR)

10.1, PLBCMP GUI Only

The GetMessage method retrieves the error message associated with an error being accessed on the error stack. 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 the maximum number of errors allowed on the error stack.

position

Optional. A Numeric Variable or decimal number whose value is a one relative position in the current error stack for the error being accessed.

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:

1. This message returned is the same as provided by the S$ERROR$ program variable.

 

Example:

I03 00000056*2 WINERR:0x2

 

2. If {position} not specified, the method uses the most recent error position.

3. The ZERO and OVER flags are set to FALSE.

4. The EOS flag is set to TRUE if the {return} variable is too small to receive all of the method data without being truncated.

5. The {flags} parameter is implemented to support future bit mask definitions to control the behaviors of this method.

See Also: Method Syntax, ERROR Methods