 | ZWManagerSetNodeName Method |
Set the name of a node.
Namespace:
OpenZWave
Assembly:
OpenZWave (in OpenZWave.dll) Version: 255.255.255.255
Syntaxpublic void SetNodeName(
uint homeId,
byte nodeId,
string nodeName
)
Public Sub SetNodeName (
homeId As UInteger,
nodeId As Byte,
nodeName As String
)
public:
virtual void SetNodeName(
[InAttribute] unsigned int homeId,
[InAttribute] unsigned char nodeId,
[InAttribute] String^ nodeName
) sealed
Parameters
- homeId
- Type: SystemUInt32
The Home ID of the Z-Wave controller that manages the node. - nodeId
- Type: SystemByte
The ID of the node to query. - nodeName
- Type: SystemString
A string containing the node's name.
RemarksThe node name is a user-editable label for the node that would normally be handled by the
Node Naming commmand class, but many devices do not support it. So that a node can always
be named, OpenZWave stores it with the node data, and provides access through this method
and GetNodeName, rather than reporting it via a command class Value object.
If the device does support the Node Naming command class, the new name will be sent to the node.
The maximum length of a node name is 16 characters.
See Also