SwitchSetSwitchName Method

Set a switch device name to a specified value.

Definition

Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public void SetSwitchName(
	short id,
	string name
)

Parameters

id  Int16
The device number (0 to MaxSwitch - 1)
name  String
The name of the device

Implements

ISwitchV2SetSwitchName(Int16, String)

Remarks

See this link for the canonical definition, which may include further information and implementation requirements: Canonical Definition

Exceptions

NotImplementedExceptionIf the device name cannot be set in the application code.
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
NotConnectedExceptionWhen Connected is False.
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.

Version Information

.NET Standard

Supported in: 2.0

See Also