ObservingConditionsSensorDescription Method |
Provides a description of the sensor providing the requested property.
Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxParameters
- PropertyName
- Type: SystemString
Name of the sensor whose description is required
Return Value
Type: StringThe description of the specified sensor.
Implements
IObservingConditionsSensorDescription(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. The device did not successfully complete the request. |
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 IObservingConditions 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