Properties of FB_JsonUtilities

Overview

Name

Data type

Access

Description

Error

BOOLEAN

Read

Indicates if an error has been detected. This value is reset every time you call a method or property.

HasChild

BOOLEAN

Read

Indicates if there are child items for the selected item.

HasParent

BOOLEAN

Read

Indicates if there is a parent item for the selected item.

IsSelected

BOOLEAN

Read

Indicates if a JSON item is selected.

IsSelectedInArray

BOOLEAN

Read

Indicates if the selected item is an element of an array.

IsSelectedInObject

BOOLEAN

Read

Indicates if the selected item is a member of an object.

NameOfParent

STRING[GPL.Gc_uiJsonMaxLengthOfName

Read

Provides the name of the parent item of the selected item. If the value is a null string, either no item is selected or the item is the root element which has no parent. Use the property Result to validate a null string value.

NameOfSelected

STRING[GPL.Gc_uiJsonMaxLengthOfName

Read/write

Retrieves or sets the name of the selected item. If the value is a null string, no item is selected or the item is the root element which has no name. Use the property Result to validate a null string value.

NumberOfChildren

UINT

Read

Provides the number of children of the selected item. If the value is 0, the item has no children or no item is selected. Use the property Result to validate a 0 value.

Result

ET_Result

Read

Provides the result of the recently called method or property. A call of this property does not affect the result itself.

ResultMsg

STRING[80]

Read

Provides additional information as a string for the given value of the property Result. A call of this property does not affect the result itself.

Timeout

Time

Read/write

After this time has elapsed, the execution of the ParseAsync / WriteAsync method is canceled. If the value is T#0s, the default value T#2s is applied.

NOTE: The elapsed time is only verified at the beginning of each cyclic method call.

TypeOfSelected

ET_JsonValueType

Read/write

Retrieves or sets the type of the value of the selected item.

ValueOfSelected

STRING[GPL.Gc_uiJsonMaxLengthOfValue]

Read/write

Retrieves or sets the value of the selected item. If the value of the selected item is a null string, either no item is selected or the item is of type TypeArray or TypeObject and has no value which can be returned as a string. Use the property Result to validate a null string value.

NOTE: By accessing a property, a previously detected error indicated by the corresponding properties is reset.