ISensor.GetChannelProperty()

Description:

The GetChannelProperty method retrieves information about a sensor channel property.

This is a synchronous method.

Syntax:

result = so.ISensor.GetChannelProperty(criteria);

Arguments:

Return value:

The GetChannelProperty method returns an object that contains the requested channel property information, an error code, and an error message.

Table: Return value properties for GetChannelProperty

Property

Description

Value

result.ReturnValue

This is an object that contains the information for the specified sensor channel property.

See Returned channel property information.

result.ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

result.ErrorMessage

This is a text string that describes the error.

See Sensor Service API error messages.

Example code:

For the complete source of a sample widget that demonstrates how to use this Service API, see the full example.