Observing |
Provides a description of the sensor providing the requested property
Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 7.0.0-rc.0+0
SyntaxParameters
- PropertyName String
- Name of the sensor whose description is required
Return Value
StringThe description of the specified sensor.
Implements
IObservingConditionsV2SensorDescription(String)Exceptions| Exception | Condition |
|---|---|
| MethodNotImplementedException | If the sensor is not implemented. |
| InvalidValueException | If an invalid property name parameter is supplied. |
| 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. |
RemarksMust Not throw a MethodNotImplementedException when the specified sensor Is implemented but must throw a MethodNotImplementedException when the specified sensor Is Not implemented.
PropertyName must be the name of one of the sensor properties specified in the IObservingConditionsV2 interface. If the caller supplies some other value, throw an InvalidValueException.
If the sensor is implemented, this must return a valid string, even if the driver is not connected, so that applications can use this to determine what sensors are available.
If the sensor is not implemented, this must throw a MethodNotImplementedException.
See Also