GetString Method (JSONDATA)

10.8, PLBCMP GUI Only

The GetString method returns the JSON field value from a JSONDATA object using the JSON key specified by the field key name. This method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A JSONDATA object previously declared.

return

Optional. A Character Variable that returns the output JSON value string. If an error occurs while retrieving the string from the JSON value, the Character Variable is returned as a NULL variable.

name

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

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 set if the output JSON string is truncated because the {return} variable is too small.

2. The ZERO and OVER flags are always cleared.

3. 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.

4. 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