Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData Functions (continued)

JSONGetInteger Function

Overview

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

Syntax/Parameters

Syntax

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

Parameters

hJSON

A string representing

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 representing the data associated with the specified item or zero on failure. Use the GetLastError and GetLastErrorMessage functions to retrieve additional error information.

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 JSONGetInteger 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

Platform Support

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

Legato IDE, Legato Basic