GetItemString
PowerScript function
Syntax 1: GetItemString ( ItemHandle )
Syntax 2: GetItemString ( ParentItemHandle, Key )
Syntax 3: GetItemString ( ItemPath )
Syntax 1
Description
Gets the value of the item whose type is string.
Applies to
Syntax
|
1 |
objectname.GetItemString ( ItemHandle ) |
|
Argument |
Description |
|---|---|
|
objectname |
The name of the JSONParser object whose item value you |
|
ItemHandle |
A long whose value is the item handle of JsonStringItem |
Return value
String.
Returns the string 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 second child item according to
the item handle:
|
1 2 3 4 5 6 7 8 9 10 11 |
JsonParser lnv_JsonParser String ls_Json, ls_name Long ll_RootObject, ll_item 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, 2) ls_name = lnv_JsonParser.GetItemString(ll_item) |
Syntax 2
Description
Gets the value of the item whose type is string.
Applies to
Syntax
|
1 |
objectname.GetItemString ( ParentItemHandle, Key ) |
|
Argument |
Description |
|---|---|
|
objectname |
The name of the JSONParser object whose child item value |
|
ParentItemHandle |
A long whose value is the handle of the parent item of |
|
Key |
A string whose value is the key of the child item of |
Return value
String.
Returns the string 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 “name” child item according to
the parent item handle and the key name:
|
1 2 3 4 5 6 7 8 9 10 |
JsonParser lnv_JsonParser String ls_Json, ls_name Long ll_RootObject lnv_JsonParser = Create JsonParser ls_Json = '{"id":1001, "name":"svan", "active":true}' lnv_JsonParser.LoadString(ls_Json) ll_RootObject = lnv_JsonParser.GetRootItem() ls_name = lnv_JsonParser.GetItemString(ll_RootObject, "name") |
Syntax 3
Description
Gets the value of the item whose type is string.
Applies to
Syntax
|
1 |
objectname.GetItemString ( ItemPath ) |
|
Argument |
Description |
|---|---|
|
objectname |
The name of the JSONParser object whose item value you |
|
ItemPath |
A string whose value is the path of the item of |
Return value
String.
Returns the string 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 second child item according to
the item path:
|
1 2 3 4 5 6 7 8 9 |
JsonParser lnv_JsonParser String ls_Json, ls_name, ls_Path lnv_JsonParser = Create JsonParser ls_Json = '{"id":1001, "name":"svan", "active":true}' lnv_JsonParser.LoadString(ls_Json) ls_Path = "/name" ls_name = lnv_JsonParser.GetItemString(ls_Path) |
See also