ISwitchV3SetSwitchName Method

Set a switch device name to a specified value.

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
C#
void SetSwitchName(
	short id,
	string name
)

Parameters

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

Remarks

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

Exceptions

MethodNotImplementedExceptionIf the device name cannot be set in the application code.
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
NotConnectedExceptionIf the device is not connected
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.

Revision History

DateVersionDescription
ISwitchV2Platform 6.1Member added.

See Also