EVT_SENSOR_DRIVER_GET_DATA_FIELD_PROPERTIES callback function (sensorscx.h)

Article
02/22/2024

This callback function returns the properties of a given data field associated with a sensor.

Syntax

EVT_SENSOR_DRIVER_GET_DATA_FIELD_PROPERTIES EvtSensorDriverGetDataFieldProperties;

NTSTATUS EvtSensorDriverGetDataFieldProperties(
  [in]                SENSOROBJECT Sensor,
  [in]                const PROPERTYKEY *pDataField,
  [in, out, optional] PSENSOR_COLLECTION_LIST pProperties,
  [out]               PULONG pSize
)
{...}

Parameters

[in] Sensor

A reference to a sensor object.

[in] pDataField

A reference to a data field. For more information see Sensor data fields.

[in, out, optional] pProperties

A list of properties and their values for the specified Sensor. For more information see SENSOR_COLLECTION_LIST

[out] pSize

The size of pDataField.

Return value

This function returns STATUS_SUCCESS when completed successfully.

Remarks

This function must be implemented by the driver and is called by the class extension.

Note

The class extension (CX) only uses the NT_SUCCESS macro to determine if the call to the driver’s Evt function was successful, but does not take any action if the function failed or does not return STATUS_SUCCESS.

Requirements

Requirement	Value
Target Platform	Windows
Header	sensorscx.h
IRQL	requires_same