Returns the maximum value for this switch device, this must be greater than MinSwitchValue(Int16).

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

Syntax

C#
double MaxSwitchValue(
	short id
)
Visual Basic
Function MaxSwitchValue ( _
	id As Short _
) As Double
Visual C++
double MaxSwitchValue(
	short id
)

Parameters

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

Return Value

The maximum value to which this device can be set or which a read only sensor will return.

Remarks

Must be implemented, must not throw a MethodNotImplementedException.

If a two state device cannot report its state, MaxSwitchValue(Int16) should return the value 1.0.

Devices are numbered from 0 to MaxSwitch - 1.

This is a Version 2 method.

Exceptions

ExceptionCondition
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1

See Also