Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

JSONGetType Function

Overview

The JSONGetType function returns the data type associated with a specified item in the object.

Syntax/Parameters

Syntax

int = JSONGetType ( handle hJSON, int index );

int = JSONGetType ( 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 int representing the data type associated with the specified item or a formatted error code. Use the GetLastError and GetLastErrorMessage functions to retrieve additional error information.

Remarks

The types returned can be the following:

  SDK Define   Ordinal   Description  
  JSON_DATA_TYPE_NULL   0   NULL Type (empty)  
  JSON_DATA_TYPE_STRING   1   String Type (UTF-8 encoded)  
  JSON_DATA_TYPE_NUMBER   2   Number Type  
  JSON_DATA_TYPE_OBJECT   3   Object Type  
  JSON_DATA_TYPE_ARRAY   4   Array Type  
  JSON_DATA_TYPE_BOOL   5   Boolean Type  

 

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

Page revised 2024-12-13