AppExtendedError Method (CLIENT)

PLB Web Only, 9.9

The AppExtendedError method provides extra error information when the error code 'AppErrorWithExtendedInfo' is returned as the result of a method call. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A CLIENT object.

return

Optional. A Character String Variable that receives the extended error string data in JSON notation.

options

Optional. A Numeric Variable or decimal number that controls the behavior of the method.

Flags Affected: EOS

Note the following:

1. The EOS flag is set to TRUE if the {return} variable is too small to receive the extended error data without being truncated.

2. The {options} parameter is a numeric value that controls the behavior of the method as follows:

 

Value	Description
0	This is the default value of this method. By default the execution of this method automatically clears the extended error information data.
1	The extended error information is not cleared when the method is executed.

 

Example Code

      Client.AppExtendedError GIVING S$CMDLIN

See Also: CLIENT, Client Methods, Method Syntax