Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData Functions (continued)

JSONGetString Function

Overview

The JSONGetString function locates a specified item in the object and if able, returns a string value of the object.

Syntax/Parameters

Syntax

string = JSONGetString ( 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 a string copy of the data associated with the specified item or an empty string on error. Use the GetLastError and GetLastErrorMessage functions to retrieve additional error information.

Remarks

Null, number, string and number items can be returned as strings. The original object type is returned in the last error code.

The JSONGetString 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.

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.

Related Functions

Platform Support

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

Legato IDE, Legato Basic