| Both sides previous revision Previous revision | |
| guides:programming:programmers_reference_manual:rti_json9_function [2025/04/07 14:50] – bshumsky | guides:programming:programmers_reference_manual:rti_json9_function [2025/04/07 14:54] (current) – bshumsky |
|---|
| ^Action^Description^ | ^Action^Description^ |
| |Parse|Handle: the javascript function or JSON expression\\ \\ Return value: the handle to use for subsequent RTI_JSON9 calls if successful, or 0 if unsuccessful| | |Parse|Handle: the javascript function or JSON expression\\ \\ Return value: the handle to use for subsequent RTI_JSON9 calls if successful, or 0 if unsuccessful| |
| | |New|Handle: unused, pass in empty string (“”)\\ \\ Param1: the type of variable to create. Valid types include “OBJECT” (for a generic object), “NUMBER”, “STRING”, “BOOLEAN”, “DATE”, “REGEXP”, and “ARRAY”\\ \\ Param2: the initial value of the created variable\\ \\ Param3: the optional time value for a DATE, or the optional flags for a REGEXP\\ \\ Return value: the evaluated variable object| |
| | |Stringify|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Return value: the string representation of the JSON object| |
| |GetValue|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: 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|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: 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|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: 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\\ \\ Return value: 0 if successful, or OLE error code| | |SetValue|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: 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\\ \\ Return value: 0 if successful, or OLE error code| |
| |Stringify|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Return value: the string representation of the JSON object| | |GetObject|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the variable to extract\\ \\ Return value: the handle of the extracted object to use for subsequent RTI_JSON9 calls| |
| | |SetObject|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the element to update\\ \\ Param2: the variable that contains the previously-created JSON object to insert\\ \\ Return value: handle if successful, or null otherwise| |
| | |isObject|Handle: the element to examine\\ \\ Return value: '1' if the element is an object or '0' otherwise| |
| |GetProperties|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Return value: @VM delimited list of the properties of the javascript or JSON object| | |GetProperties|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Return value: @VM delimited list of the properties of the javascript or JSON object| |
| | |GetLength|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the element to evaluate\\ \\ Return value: the length of the specified element| |
| |Eval|Handle: unused, pass in empty string (“”)\\ \\ Param1: javascript source or JSON string\\ \\ Return value: the evaluated object| | |Eval|Handle: unused, pass in empty string (“”)\\ \\ Param1: javascript source or JSON string\\ \\ Return value: the evaluated object| |
| |New|Handle: unused, pass in empty string (“”)\\ \\ Param1: the type of variable to create. Valid types include “OBJECT” (for a generic object), “NUMBER”, “STRING”, “BOOLEAN”, “DATE”, “REGEXP”, and “ARRAY”\\ \\ Param2: the initial value of the created variable\\ \\ Param3: the optional time value for a DATE, or the optional flags for a REGEXP\\ \\ Return value: the evaluated variable object| | |
| |GetObject|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the variable to extract\\ \\ Return value: the handle of the extracted object to use for subsequent RTI_JSON9 calls| | |
| |DeleteItem\\ DeleteObject|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the element to delete\\ \\ Return value: '1' if successful, '0' otherwise| | |DeleteItem\\ DeleteObject|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the element to delete\\ \\ Return value: '1' if successful, '0' otherwise| |
| |GetLength|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the element to evaluate\\ \\ Return value: the length of the specified element| | |
| |SetObject|Handle: the variable that contains the previously-created javascript or JSON object\\ \\ Param1: the name of the element to update\\ \\ Param2: the variable that contains the previously-created JSON object to insert\\ \\ Return value: handle if successful, or null otherwise| | |
| |Refresh|Handle: unused\\ \\ Param1: unused\\ \\ Return value: none| | |Refresh|Handle: unused\\ \\ Param1: unused\\ \\ Return value: none| |
| |isObject|Handle: the element to examine\\ \\ Return value: '1' if the element is an object or '0' otherwise| | |
| |
| |