Syntax 1: GetItemBoolean (ItemHandle)
Syntax 2: GetItemBoolean (ParentItemHandle, Key)
Syntax 3: GetItemBoolean (ItemPath)
Description
Gets the value of the item whose type is boolean.
Applies to
Syntax
objectname.GetItemBoolean ( ItemHandle )
|
Argument |
Description |
|---|---|
|
objectname |
The name of the JSONParser object whose item value you want to obtain. |
|
ItemHandle |
A long whose value is the item handle of JsonBooleanItem type. |
Return value
Boolean.
Returns the boolean value of the item if it succeeds; if any argument's value is null, returns null; if an error occurs, the SystemError event will be triggered.
Usage
If the item value is null, this function will throw an error, therefore, it is recommended that before executing this function, call GetItemType to check if the item value is null. See example 2 in GetItemArray.
Examples
This example gets the value of the third child item according to the item handle:
JsonParser lnv_JsonParser
String ls_Json
Long ll_RootObject, ll_item
Boolean lb_active
lnv_JsonParser = Create JsonParser
ls_Json = '{"id":1001, "name":"svan", "active":true}'
lnv_JsonParser.LoadString(ls_Json)
ll_RootObject = lnv_JsonParser.GetRootItem()
ll_item = lnv_JsonParser.GetChildItem(ll_RootObject, 3)
lb_active = lnv_JsonParser.GetItemBoolean(ll_item)
Description
Gets the value of the item whose type is boolean.
Applies to
Syntax
objectname.GetItemBoolean ( ParentItemHandle, Key )
|
Argument |
Description |
|---|---|
|
objectname |
The name of the JSONParser object whose child item value you want to obtain. |
|
ParentItemHandle |
A long whose value is the handle of the parent item of JsonObjectItem type. |
|
Key |
A string whose value is the key of the child item of JsonBooleanItem type. |
Return value
Boolean.
Returns the boolean value of the child item if it succeeds; if any argument's value is null, returns null; if an error occurs, the SystemError event will be triggered.
Usage
If the item value is null, this function will throw an error, therefore, it is recommended that before executing this function, call GetItemType to check if the item value is null. See example 2 in GetItemArray.
Examples
This example gets the value of the "active" item according to the parent item handle and the key name:
JsonParser lnv_JsonParser
String ls_Json
Long ll_RootObject
Boolean lb_active
lnv_JsonParser = Create JsonParser
ls_Json = '{"id":1001, "name":"svan", "active":true}'
lnv_JsonParser.LoadString(ls_Json)
ll_RootObject = lnv_JsonParser.GetRootItem()
lb_active = lnv_JsonParser.GetItemBoolean(ll_RootObject, "active")
Description
Gets the value of the item whose type is boolean.
Applies to
Syntax
objectname.GetItemBoolean ( ItemPath )
|
Argument |
Description |
|---|---|
|
objectname |
The name of the JSONParser object whose item value you want to obtain. |
|
ItemPath |
A string whose value is the path of the item of JsonBooleanItem type. If there is a multi-dimensional array, use the number to indicate the order of the array elements. If a key name contains "/", use the escape character "~~/" to replace "/". |
Return value
Boolean.
Returns the boolean value of the item if it succeeds; if any argument's value is null, returns null; if an error occurs, the SystemError event will be triggered.
Usage
If the item value is null, this function will throw an error, therefore, it is recommended that before executing this function, call GetItemType to check if the item value is null. See example 2 in GetItemArray.
Examples
This example gets the value of the third child item according to the item path:
JsonParser lnv_JsonParser
String ls_Json, ls_Path
Boolean lb_active
lnv_JsonParser = Create JsonParser
ls_Json = '{"id":1001, "name":"svan", "active":true}'
lnv_JsonParser.LoadString(ls_Json)
ls_Path = "/active"
lb_active = lnv_JsonParser.GetItemBoolean(ls_Path)
See also
