%JSON_ArrayGetObject function

Function

Gets the object on the specified index from the JSON array.

Declaration

INT %JSON_ArrayGetObject(
    INT in handle, 
    INT in index
 )

Parameters

handle	Handle to parent JSON array.
index	Index of the object.

Return value

Handle to JSON object, must be allowed by %JSON_FreeObjectHandle.

Description

The function gets an object on the specified index from the JSON array.

If the item type is not an object, the handle on the JSON array is invalid, or the index is invalid, an exception is thrown.

Example

 INT _arr
 _arr := %JSON_ArrayFromString('[{"Name":"John"}]')
 
 INT _obj
 _obj := %JSON_ArrayGetObject(_arr, 1)

 %JSON_FreeObjectHandle(_obj)
 %JSON_FreeArrayHandle(_arr)