ISensor.FindSensorChannel()

Description:

The FindSensorChannel method searches for sensor channels available on the device.

This is a synchronous method.

Syntax:

result = so.ISensor.FindSensorChannel(criteria);

Arguments:

  • criteria:

    This is an object that specifies the search criteria. For more information about the object properties and how to define them, see section Criteria for searching sensor channels.

Return value:

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

Table: Return value properties for FindSensorChannel

Property

Description

Value

result.ReturnValue

This is an iterator that contains information about the sensor channels matching the search criteria.

See Sensor channel 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.