Delete Method (JSONDATA)

10.8, PLBCMP GUI Only

The Delete method deletes a JSONDATA object node specified by the JSON 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 Numeric Variable that returns a value of zero.

name

Required. A Character String Variable or literal that specifies the key name for a JSON field being deleted.

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 TRUE for a value of zero.

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