WdfDeviceQueryInterfaceProperty function (wdfdevice.h)

[Applies to UMDF only]

The WdfDeviceQueryInterfaceProperty method retrieves a specified device interface property.

Syntax

NTSTATUS WdfDeviceQueryInterfaceProperty(
  [in]  WDFDEVICE                           Device,
  [in]  PWDF_DEVICE_INTERFACE_PROPERTY_DATA PropertyData,
  [in]  ULONG                               BufferLength,
  [out] PVOID                               PropertyBuffer,
  [out] PULONG                              ResultLength,
  [out] PDEVPROPTYPE                        Type
);

Parameters

[in] Device

A handle to a framework device object.

[in] PropertyData

A pointer to a WDF_DEVICE_INTERFACE_PROPERTY_DATA structure that identifies the device interface property to be retrieved.

[in] BufferLength

The size, in bytes, of the buffer that is pointed to by PropertyBuffer.

[out] PropertyBuffer

A pointer to a caller-allocated buffer that receives the requested device interface property. The pointer can be NULL if the BufferLength parameter is zero.

[out] ResultLength

A caller-supplied location that, on return, contains the size, in bytes, of the information that WdfDeviceQueryInterfaceProperty stored in PropertyBuffer. If the function's return value is STATUS_BUFFER_TOO_SMALL, this location receives the required buffer size.

[out] Type

A pointer to a DEVPROPTYPE-typed variable that identifies the type of property data that WdfDeviceQueryInterfaceProperty stored in the buffer that PropertyBuffer points to.

Return value

If the WdfDeviceQueryInterfaceProperty method encounters no errors, it returns STATUS_SUCCESS. Additional return values include:

The method might return other NTSTATUS values.

Remarks

Before receiving device property data, drivers typically call the WdfDeviceQueryInterfaceProperty method just to obtain the required buffer size. For some properties, the data size can change between when the required size is returned and when the driver calls WdfDeviceQueryInterfaceProperty again. Therefore, drivers should call WdfDeviceQueryInterfaceProperty inside a loop that executes until the return status is not STATUS_BUFFER_TOO_SMALL.

It is best to use WdfDeviceQueryInterfaceProperty only if the required buffer size is known and unchanging, because in that case the driver has to call WdfDeviceQueryInterfaceProperty only once. If the required buffer size is unknown or varies, the driver should call WdfDeviceAllocAndQueryInterfaceProperty.

For information about related methods, see Accessing the Unified Device Property Model.

Requirements

See also

WDF_DEVICE_INTERFACE_PROPERTY_DATA

WDF_DEVICE_INTERFACE_PROPERTY_DATA_INIT

WdfDeviceAllocAndQueryInterfaceProperty

WdfDeviceAssignInterfaceProperty