cnsGetProperty

Retrieves the key value from the property of the defined node.

Synopsis

bool cnsGetProperty(string cnsPath, string key, anytype &value);

Parameters

Parameter Description
cnsPath ID path of the node
key Key name
value Key value

Return value

TRUE or FALSE indicating success or failure of the operation.

Errors

Possible errors:

  • Wrong or missing parameters

  • The defined node could not be found

  • The defined key does not exist

Description

Retrieves the key value from the property of the defined node and writes it to the variable value. The function returns FALSE if the given key does not exist.

main()
{
  anytype value;
  cnsGetProperty("System1.View1:Node3.Node1", "OA:OPC", value)
}

Availability

UI, CTRL