| Both sides previous revision Previous revision | |
| guides:programming:programmers_reference_manual:rti_jsonx_function [2025/04/07 13:51] – bshumsky | guides:programming:programmers_reference_manual:rti_jsonx_function [2025/04/07 14:56] (current) – bshumsky |
|---|
| ^Method^Description^ | ^Method^Description^ |
| |Parse|Object: the JSON expression\\ \\ Return value: the handle to use for subsequent RTI_JSONX calls if successful, or 0 if unsuccessful.| | |Parse|Object: the JSON expression\\ \\ Return value: the handle to use for subsequent RTI_JSONX calls if successful, or 0 if unsuccessful.| |
| | |New|Object: unused, pass in empty string (“”)\\ \\ Param1: the type of variable to create. Valid types include “OBJECT” (for a generic object), “NUMBER”, “STRING”, “BOOLEAN”, “DATE”, and “ARRAY”\\ \\ Param2: the initial value of the created variable\\ \\ Param3: the delimiter to use when parsing an ARRAY, or the time part when parsing a DATE\\ \\ Return value: the evaluated variable object| |
| | |Stringify|Object: the variable that contains the previously-created JSON object\\ \\ Return value: the string representation of the JSON object| |
| |GetValue|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the "path" in the JSON string to the desired variable\\ \\ Param2: (optional) the name of the variable whose value should be retrieved. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Return value: the specified variable’s value| | |GetValue|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the "path" in the JSON string to the desired variable\\ \\ Param2: (optional) the name of the variable whose value should be retrieved. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Return value: the specified variable’s value| |
| |SetValue|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the name, or path (terminating in the name) of the variable whose value should be set. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Param2: the value to which the variable should be set\\ \\ Param3: The type of the value to set. Valid types include "NULL","BOOLEAN","NUMBER", and "STRING"\\ \\ Return value: none| | |SetValue|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the name, or path (terminating in the name) of the variable whose value should be set. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Param2: the value to which the variable should be set\\ \\ Param3: The type of the value to set. Valid types include "NULL","BOOLEAN","NUMBER", and "STRING"\\ \\ Return value: none| |
| |GetLength|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the name of the variable to examine\\ \\ Return value: the number of elements in the named variable| | |
| |GetObject|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the "path" in the JSON string to the desired variable\\ \\ Param2: (optional) the name of the variable whose value should be retrieved. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Return value: a JSON object representing the specified variable’s value| | |GetObject|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the "path" in the JSON string to the desired variable\\ \\ Param2: (optional) the name of the variable whose value should be retrieved. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Return value: a JSON object representing the specified variable’s value| |
| |SetObject|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the name, or path (terminating in the name) of the variable whose value should be set. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Param2: the variable that contains the previously-created JSON object to which the variable should be set\\ \\ Return value: "1" if successful, "0" otherwise| | |SetObject|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the name, or path (terminating in the name) of the variable whose value should be set. This can be an array element (enclosed in square braces, ie, “[1]”) if accessing an array object.\\ \\ Param2: the variable that contains the previously-created JSON object to which the variable should be set\\ \\ Return value: "1" if successful, "0" otherwise| |
| |Stringify|Object: the variable that contains the previously-created JSON object\\ \\ Return value: the string representation of the JSON object| | |isObject|Object: the variable that contains the previously-created JSON object, or a handle to a previously-extracted element\\ \\ Param1: the name of the element inside //Object// to examine\\ \\ Param2: optional delimiter\\ \\ Return value: "1" if the element is an object, "0" otherwise| |
| |GetProperties|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the path (terminating in the name) of the variable whose properties should be returned\\ \\ Param2: the delimiter to use when returning the list of properties\\ \\ Return value: If Param1 specifies an array, then the return value is the number of elements, otherwise the return value is a list of the properties of the JSON object (separated by the specified delimiter in Param2)| | |GetProperties|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the path (terminating in the name) of the variable whose properties should be returned\\ \\ Param2: the delimiter to use when returning the list of properties\\ \\ Return value: If Param1 specifies an array, then the return value is the number of elements, otherwise the return value is a list of the properties of the JSON object (separated by the specified delimiter in Param2)| |
| |New|Object: unused, pass in empty string (“”)\\ \\ Param1: the type of variable to create. Valid types include “OBJECT” (for a generic object), “NUMBER”, “STRING”, “BOOLEAN”, “DATE”, and “ARRAY”\\ \\ Param2: the initial value of the created variable\\ \\ Param3: the delimiter to use when parsing an ARRAY, or the time part when parsing a DATE\\ \\ Return value: the evaluated variable object| | |GetLength|Object: the variable that contains the previously-created JSON object\\ \\ Param1: the name of the variable to examine\\ \\ Return value: the number of elements in the named variable| |
| |Delete|Object: the variable that contains the previously-created JSON object\\ \\ Param1: (optional) the path to the variable to delete from the object. If not specified, the entire object will be deleted\\ \\ Return value: "1" if successful, "0" otherwise| | |Delete|Object: the variable that contains the previously-created JSON object\\ \\ Param1: (optional) the path to the variable to delete from the object. If not specified, the entire object will be deleted\\ \\ Return value: "1" if successful, "0" otherwise| |
| |isObject|Object: the variable that contains the previously-created JSON object, or a handle to a previously-extracted element\\ \\ Param1: the name of the element inside //Object// to examine\\ \\ Param2: optional delimiter\\ \\ Return value: "1" if the element is an object, "0" otherwise| | |
| |Free\\ Destroy|Object: the variable that contains the previously-created JSON object\\ \\ Return value: none| | |Free\\ Destroy|Object: the variable that contains the previously-created JSON object\\ \\ Return value: none| |
| |