 | ZWManagerSetValueListSelection Method |
Sets the selected item in a list.
Namespace:
OpenZWave
Assembly:
OpenZWave (in OpenZWave.dll) Version: 255.255.255.255
Syntaxpublic bool SetValueListSelection(
ZWValueId id,
string selectedItem
)
Public Function SetValueListSelection (
id As ZWValueId,
selectedItem As String
) As Boolean
public:
virtual bool SetValueListSelection(
[InAttribute] ZWValueId^ id,
[InAttribute] String^ selectedItem
) sealed
Parameters
- id
- Type: OpenZWaveZWValueId
The unique identifier of the list value. - selectedItem
- Type: SystemString
[Missing <param name="selectedItem"/> documentation for "M:OpenZWave.ZWManager.SetValueListSelection(OpenZWave.ZWValueId,System.String)"]
Return Value
Type:
Booleantrue if the value was set. Returns false if the selection is not in the list, or if the value is not a ZWValueID::ValueType_List.
The type can be tested with a call to ZWValueID::GetType
Remarks
Due to the possibility of a device being asleep, the command is assumed to suceeed, and the value
held by the node is updated directly. This will be reverted by a future status message from the device
if the Z-Wave message actually failed to get through. Notification callbacks will be sent in both cases.
See Also