Edit

Share via

HidSpiCxDeviceConfigure function (hidspicx.h)

  • Article

After calling WdfDeviceCreate, and still in its EVT_WDF_DRIVER_DEVICE_ADD callback, the client driver calls this function with a pointer to a HIDSPICX_DEVICE_CONFIG structure, specifying interfaces the class extension will use to communicate with the device. The class extension initializes its internal state, returning whether or not this is successful.

Syntax

NTSTATUS HidSpiCxDeviceConfigure(
  [in] WDFDEVICE               Device,
  [in] PHIDSPICX_DEVICE_CONFIG DeviceConfiguration
);

Parameters

[in] Device

A handle to a framework device object the client driver obtained from a previous call to WdfDeviceCreate.

[in] DeviceConfiguration

Pointer to an initialized HIDSPICX_DEVICE_CONFIG structure, specifying the details of the callbacks and queues to be used for communication between the class extension and client driver.

Return value

NTSTATUS indicating whether the class extension was able to successfully configure the device.

Remarks

The class extension initializes the internal state, returning whether or not this is successful.

The client driver may create a default queue before or after making this callback, in order to handle IOCTLs not handled by the class extension.

Client drivers should not attempt to acquire power policy ownership to configure power policy settings. HidClass and HidSpiCx are responsible for managing the power policy of the device.

Requirements

Requirement Value
Minimum supported client Windows 11
Header hidspicx.h

See also