SetBoolean Method (JSONDATA)

10.8, PLBCMP GUI Only

The SetBoolean method is used to create a JSON field with a Boolean type and place it into the current JSONDATA object. This method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A JSONDATA object previously declared.

return

Optional. A Numeric Variable that returns a pass (0) or fail (!0) value.

name

Required. A Character String Variable or literal that specifies a JSON field name for a JSONDATA object.

value

Required. A Character String Variable, literal, Numeric Variable, decimal number, or Numeric expression that specifies the JSON Boolean value for a JSON field.

index1

Optional. A Numeric Variable, decimal number, or Numeric expression that defines the first index of a JSON array that is being accessed.

index2

Optional. A Numeric Variable, decimal number, or Numeric expression that defines the second index of a JSON multi-dimensioned array that is being accessed.

index3

Optional. A Numeric Variable, decimal number, or Numeric expression that defines the third index of a JSON multi-dimensioned array that is being accessed.

Flags Affected: EOS, OVER, ZERO

Notes:

1. The EOS flag is always cleared.

2. The ZERO flag is set if the return value is zero. Otherwise, the ZERO flag is cleared for non-zero values.

3. The OVER flag is set if the return value must be truncated.

4. At runtime, the tokens $1, $2, and $3 that appear in the {name} parameter are replaced with the numeric values of the corresponding {index1}, {index2}, or {index3} parameters.

5. The error values returned in {return} are defined as follows:

 

Error	Description
1	Memory allocation error.
5	JSON error type mismatch.
7	JSON method input is null or invalid.

 

6. If an error occurs, the JSONDATA object method 'SyntaxError' can be used to retrieve that last error that was generated..

See Also: Method Syntax, JSONDATA Methods