cnsRemoveProperty

Removes the key from the property of the given node.

Synopsis

bool cnsRemoveProperty(string cnsPath, string key);

Parameters

Parameter Description
cnsPath ID path of the node
key Key name

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

Description

Removes the key from the property of the given node. The return value TRUE indicates that the key is successfully removed. Therefore the function returns also TRUE if the given key does not exist.

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

Availability

UI, CTRL