IObservingConditionsV2SensorDescription Method

Provides a description of the sensor providing the requested property

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
C#
string SensorDescription(
	string PropertyName
)

Parameters

PropertyName  String
Name of the sensor whose description is required

Return Value

String
The description of the specified sensor.

Remarks

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

Exceptions

MethodNotImplementedExceptionIf the sensor is not implemented.
InvalidValueExceptionIf an invalid property name parameter is supplied.
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
IObservingConditionsPlatform 6.2Member added.

See Also