GetProgram Method (ERROR)

10.1, PLBCMP GUI Only

The GetProgram method retrrieves the program name for 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 Character String Variable that receives the program name of the error being accessed 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. If the {position} parameter is not specified, this method uses the position of the most recent error.

2. The ZERO and OVER flags are always set to be FALSE.

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

4. The {flags} parameter is implemented to support future method behaviors.

See Also: Method Syntax, ERROR Methods