GetMaxTextSize Method (ERROR)

10.1, PLBCMP GUI Only

The GetMaxTextSize method retrieves the maximum text size of a message or sub message string. 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. If {position} not specified, the method uses the most recent error position.

2. The ZERO flag is set if the {return} value is zero.

3. The OVER flag is set if the returned value overflows the {return} Numeric Variable.

4. The EOS flag is always set to FALSE.

5. The {flags} bit mask values are described as follows:

 

Value	Keyword	Behavior
0x1	MAXTEXTSIZEALL	The method gets the maximum text size for all of the errors on the error stack.

See Also: Method Syntax, ERROR Methods