Set a switch device name to a specified value.

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
void SetSwitchName(
	short id,
	string name
)
Visual Basic
Sub SetSwitchName ( _
	id As Short, _
	name As String _
)
Visual C++
void SetSwitchName(
	short id, 
	String^ name
)

Parameters

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

Remarks

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

Devices are numbered from 0 to MaxSwitch - 1

Exceptions

ExceptionCondition
MethodNotImplementedExceptionIf the device name cannot be set in the application code.
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1

See Also