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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

JSONGetFloat Function

Overview

The JSONGetFloat function retrieves the data for a specified item in an object and, if possible, translates the value into an floating point value.

Syntax/Parameters

Syntax

float = JSONGetFloat ( handle hJSON, int index );

float = JSONGetFloat ( handle hJSON, string item, [params ...] );

Parameters

hJSON

A handle to a JSON Object.

index

An int value specifying object or node index within the JSON Object. Or,

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 float representing the data associated with the specified item or NaN on failure. Use the GetLastError and GetLastErrorMessage functions to retrieve additional error information. IsNan can also be used to check for an error.

Remarks

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.

The JSONGetFloat function retrieves data associated with 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.

If the data types is not compatible for translation, or the number is floating point, a ERROR_CONTEXT or ERROR_SYNTAX error will be set in the last error ORed with the JSON object type. See JSONGetType for a list of object types.

Related Functions

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

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

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

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

JSONGetString — Returns a specified object by item as a string.

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

JSONLoad — Loads JSON data into an object for reading.

NaN — Returns a float as an invalid number (not a number or NaN).

IsNaN — Tests for a valid floating-point value.

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.