Symbol.setValueFromJson Function

Format

b = symbol_name.setValueFromJson(json);

Description

The Symbol.setValueFromJson function modifies the value of a symbol based on the symbol's JSON representation, passed to the function as the string expression json.

You can also use the Logic.setSymbolValue action to update a symbol's value.

The following table describes the value-related serialization routines available for CSPro objects and contains links to the description of the JSON representation for each object.

Documentation about all JSON representations feature will come in a future release.

Object	Value -> JSON	JSON -> Value	Serialization
numeric	✔	✔	CSPro ⇄ JSON Conversions: Numeric Values
string, alpha	✔	✔	CSPro ⇄ JSON Conversions: String Values
Array	✔	✔	CSPro ⇄ JSON Conversions: Array Object
Audio	✔	✔	CSPro ⇄ JSON Conversions: Audio Object
Block
Dictionary	✔
Document	✔	✔	CSPro ⇄ JSON Conversions: Document Object
File	✔
Freq	✔
function
Geometry	✔	✔	CSPro ⇄ JSON Conversions: Geometry Object
HashMap	✔	✔	CSPro ⇄ JSON Conversions: HashMap Object
Image	✔	✔	CSPro ⇄ JSON Conversions: Image Object
Item
List	✔	✔	CSPro ⇄ JSON Conversions: List Object
Map
Pff
Record
Report	✔	✔	CSPro ⇄ JSON Conversions: Report Object
StringWriter	✔	✔	CSPro ⇄ JSON Conversions: StringWriter Object
SystemApp	✔	✔
ValueSet	✔	✔

Return Value

The function returns a logical value of 1 (true) if the symbol's value was successfully updated from its JSON representation and 0 (false) otherwise.

Example

List string usmca_countries
usmca_countries.setValueFromJson("[ \"Canada\", \"Mexico\", \"United States\" ]");

// 3 countries are part of USMCA, including Canada and United States.
errmsg("%d countries are part of USMCA, including %s and %s.",
usmca_countries.length(),
usmca_countries(1), usmca_countries(usmca_countries.length()));