GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

JSONGetObjectIndex Function

Overview

The JSONGetObjectIndex function locates a specific object and returns the node index to that object.

Syntax/Parameters

Syntax

int = JSONGetObjectIndex ( handle hJSON, string item, [params ...] );

Parameters

hJSON

A handle to a JSON Object.

item

A string representing the item to capture from the object. The string can be a formatted string.

params

An optional series of parameters that can be applied to the formatted string.

Return Value

Returns an int as a zero-based object node index or -1 on error. Use the GetLastError and GetLastErrorMessage functions to retrieve additional error information.

On success, the last error value will contain the type of object located.

Remarks

The JSONGetObjectIndex function retrieves the associated index to a specific node within the object. The node is “obj.name.name...” where “obj” is the root and the names are the specified location in the object.

The item and params parameters can be combined to create a formatted print string. For more information on formatted strings, see Section 5.2 String Functions.

Note that node indices may not be serial depending on the structure of the JSON data.

Related Functions

JSONGetArrayCount — Returns the number of items in an expected array at the specified position.

JSONGetFloat — Returns a specified object by item as a floating point value.

JSONGetInteger — Returns a specified object by item as an integer.

JSONGetObjectCount — Returns the number of objects at the specified position.

JSONGetObjectIndex — Finds a specified object and returns its node index.

JSONGetObjectKeyName — Returns the key name for an object at the specified position.

JSONGetValue — Returns a specified object by item as a specific type.

JSONLoad — Loads JSON data into an object for reading.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2024-12-13

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.