SensorsCxSensorDataReady function (sensorscx.h)

This function notifies the class extension that the driver has retrieved data.

Syntax

void SensorsCxSensorDataReady(
  SENSOROBJECT            Sensor,
  PSENSOR_COLLECTION_LIST pSensorData
);

Parameters

Sensor

[in] A reference to a sensor object.

pSensorData

[in] A list of Sensor properties. For more information, see SENSOR_COLLECTION_LIST.

Return value

This function returns NTSTATUS with different values. Some values that may be returned are the following:

  • STATUS_SUCCESS is returned if the function completes successfully.
  • STATUS_UNSUCCESSFUL is returned if the function does not complete successfully.
  • STATUS_INVALID_PARAMETER is returned if any of the _In_ parameters are NULL.
Note  Any client that calls SensorsCxSensorDataReady must make sure that SensorsCxSensorDataReady is Started, before the call is made. Calling SensorsCxSensorDataReady before it is Started can cause the sensor class extension to become unresponsive.
 

Remarks

This function is implemented by the class extension and the driver must call it. Note that when batch latency expires for sensor drivers that support data batching, SensorsCxSensorDataReady is called repeatedly until all the batched data samples are delivered to the client. For more information about the callback function related to batch latency, see EvtSensorSetBatchLatency.

Requirements

   
Target Platform Desktop
Header sensorscx.h

See also

EvtSensorSetBatchLatency

SENSOR_COLLECTION_LIST

Sensor properties