%JSON_ObjectGetArray function

Function

Returns the field in the specified item from a JSON object.

Declaration

INT %JSON_ObjectGetArray(
    INT in handle, 
    TEXT in field
 )

Parameters

handle	Handle to parent JSON object.
field	Field name

Return value

Handle to JSON array, must be released by %JSON_FreeArrayHandle.

Description

The function returns a field in the specified item from a JSON object.

Exception is thrown ifthe object at index is not an array, handle to JSON object is invalid or the field does not exists.

Example

 INT _obj
 _obj := %JSON_ObjectFromString('{"Array":[1,2,3]}')
 
 INT _arr
 _arr := %JSON_ObjectGetArray(_obj, "Array")

 %JSON_FreeObjectHandle(_obj)
 %JSON_FreeArrayHandle(_arr)