IWDFUsbTargetDevice::RetrieveDeviceInformation method

The RetrieveDeviceInformation method retrieves device information of the specified type.

Syntax


HRESULT RetrieveDeviceInformation(
  [in]      ULONG InformationType,
  [in, out] ULONG *BufferLength,
  [out]     PVOID Buffer
);

Parameters

InformationType [in]

The type of information that the UMDF driver requests about the device.

BufferLength [in, out]

A pointer to a variable that, on input, contains the size, in bytes, of the buffer that RetrieveDeviceInformation supplies in Buffer. On output, this parameter contains the size that RetrieveDeviceInformation requires for Buffer.

Buffer [out]

A pointer that receives the buffer that contains the device information.

Return value

RetrieveDeviceInformation returns one of the following values:

Return codeDescription
S_OK

RetrieveDeviceInformation successfully retrieved the device information.

E_OUTOFMEMORY

RetrieveDeviceInformation encountered an allocation failure.

An error code that is defined in Winerror.h

This value corresponds to the error code that the WinUsb API returned.

 

Remarks

For information about valid information types that a UMDF driver can pass for the InformationType parameter, see the WinUsb_QueryDeviceInformation function.

If InformationType is DEVICE_SPEED (0x01), on successful return, Buffer indicates the operating speed of the device. 0x03 indicates high-speed or higher; 0x01 indicates full-speed or lower.

The RetrieveDeviceInformation method generates a UMDF request and synchronously sends the request to the I/O target.

Examples

For a code example of how to use theRetrieveDeviceInformation method, see IWDFUsbTargetPipe::SetPipePolicy.

Requirements

Target platform

Desktop

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.5

Header

Wudfusb.h (include Wudfusb.h)

DLL

WUDFx.dll

See also

IWDFUsbTargetDevice
WinUsb_QueryDeviceInformation

 

 

Send comments about this topic to Microsoft

Показ:
© 2015 Microsoft