GetNumber Method (JSONDATA)

10.8, PLBCMP GUI Only

 

The GetNumber method gets and returns a numeric value from a JSONDATA object based on the type of value for a JSON field being accessed. This method uses the following format:

 

 

[label]

{object}.GetNumber

[GIVING {return}] USING [*NAME=]{name}[:

 

 

[*INDEX1=]{index1}][:

 

 

[*INDEX2=]{index2}][:

 

 

[*INDEX3=]{index3}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A JSONDATA object previously declared.

return

Optional. A Numeric Variable that returns a number based on the type of value for a JSON field specified by the name parameter.

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 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 {return} values are determined by the JSON field value type being accessed using a JSON field key specified by the {name} parameter. The JSON field value types are defined as follows:

    6.  

    Type

    Return Value

    $JSF_TYPE_OBJECT (1)

    Returns the number of fields in the json object.

    $JSF_TYPE_ARRAY (2)

    Returns the number of elements in the array.

    $JSF_TYPE_INTEGER (3)

    Returns the field integer value.

    $JSF_TYPE_DOUBLE (4)

    Returns the whole digits value. Decimal digits are not returned.

    $JSF_TYPE_STRING (5)

    Returns the length of the JSON field string.

    $JSF_TYPE_BOOLEAN (6)

    Returns the value of one for a 'true' value. If the value is 'false', the return value is zero.

    $JSF_TYPE_NULL (7)

    Returns the value of zero.

     

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

 

 

See Also: Method Syntax, JSONDATA Methods


PL/B Language Reference