ASCOM Library
Alpaca
Provides a description of the sensor providing the requested property
Definition
Namespace: ASCOM.Alpaca.Clients
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
The description of the specified sensor.
Assembly: ASCOM.Alpaca (in ASCOM.Alpaca.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public string SensorDescription(
string PropertyName
)VB
Public Function SensorDescription (
PropertyName As String
) As StringParameters
- PropertyName String
- Name of the sensor whose description is required
Return Value
StringThe description of the specified sensor.
Implements
IObservingConditionsSensorDescription(String)Remarks
See this link for the canonical definition, which may include further information and implementation requirements: Canonical Definition
Exceptions
| NotImplementedException | If the sensor is not implemented. |
| InvalidValueException | If an invalid property name parameter is supplied. |
| NotConnectedException | When Connected is False. |
| 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. |