ISwitchV2SetSwitchName Method

Set a switch device name to a specified value.

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484

Syntax

C++

Copy

void SetSwitchName(
	short id,
	string name
)

Sub SetSwitchName ( 
	id As Short,
	name As String
)

void SetSwitchName(
	short id, 
	String^ name
)

Parameters

id: Type: SystemInt16
The device number (0 to MaxSwitch - 1)
name: Type: SystemString
The name of the device

Exceptions

Exception	Condition
MethodNotImplementedException	If the device name cannot be set in the application code.
InvalidValueException	If id is outside the range 0 to MaxSwitch - 1
NotConnectedException	If the device is not connected
DriverException	An 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.

Remarks

Can throw a MethodNotImplementedException if the device name can not be set by the application.

Devices are numbered from 0 to MaxSwitch - 1

Reference

ISwitchV2 Interface

ASCOM.DeviceInterface Namespace

ISwitchV2AddLanguageSpecificTextSet("LST384A75AB_0?cpp=::|nu=.");SetSwitchName Method

Parameters

Reference

ISwitchV2SetSwitchName Method