WdfUsbTargetDeviceRetrieveInformation 関数 (wdfusb.h)

[KMDF と UMDF に適用]

WdfUsbTargetDeviceRetrieveInformation メソッドは、指定されたフレームワーク USB デバイス オブジェクトに関連付けられている USB デバイスに関する情報を取得します。

構文

NTSTATUS WdfUsbTargetDeviceRetrieveInformation(
  [in]      WDFUSBDEVICE                UsbDevice,
  [in, out] PWDF_USB_DEVICE_INFORMATION Information
);

パラメーター

[in] UsbDevice

WdfUsbTargetDeviceCreateWithParameters の以前の呼び出しから取得された USB デバイス オブジェクトへのハンドル。

[in, out] Information

USB デバイス情報を受信する呼び出し元によって割り当てられた WDF_USB_DEVICE_INFORMATION 構造体へのポインター。

戻り値

操作が成功した場合、WdfUsbTargetDeviceRetrieveInformation はSTATUS_SUCCESSを返します。 それ以外の場合、このメソッドは次のいずれかの値を返すことができます。

このメソッドは、他の NTSTATUS 値を返す場合もあります。

ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。

注釈

WdfUsbTargetDeviceRetrieveInformation メソッドと USB I/O ターゲットの詳細については、「USB I/O ターゲット」を参照してください。

フレームワーク バージョン 1.11 以降では、ドライバーは WdfUsbTargetDeviceQueryUsbCapability を呼び出してデバイスの動作速度を取得できます。

例

次のコード例は、USB デバイス オブジェクトを作成し、WDF_USB_DEVICE_INFORMATION構造体を初期化し、WdfUsbTargetDeviceRetrieveInformation を呼び出す EvtDevicePrepareHardware コールバック関数の一部です。

NTSTATUS
MyEvtDevicePrepareHardware(
    IN WDFDEVICE  Device,
    IN WDFCMRESLIST  ResourceList,
    IN WDFCMRESLIST  ResourceListTranslated
    )
{
    NTSTATUS  status;
    PMY_DEVICE_CONTEXT  pMyDeviceContext;
    WDF_USB_DEVICE_CREATE_CONFIG  Config;

    pMyDeviceContext = GetDeviceContext(Device);

    // If object handle is not NULL, MyEvtDevicePrepareHardware
    // was called previously and the handle is still valid.
    if (pMyDeviceContext->UsbDevice != NULL) {
        return STATUS_SUCCESS;
    }

    WDF_USB_DEVICE_CREATE_CONFIG_INIT(
                                      &Config,
                                      USBD_CLIENT_CONTRACT_VERSION_602
                                      );

    status = WdfUsbTargetDeviceCreateWithParameters(
                                      Device,
                                      &Config,
                                      WDF_NO_OBJECT_ATTRIBUTES,
                                      &pMyDeviceContext->UsbDevice
                                      );
    if (!NT_SUCCESS(status)) {
        return status;
    }

    WDF_USB_DEVICE_INFORMATION_INIT(&deviceInfo);

    status = WdfUsbTargetDeviceRetrieveInformation(
                                      pDeviceContext->UsbDevice, 
                                      &deviceInfo
                                      );
...
}

要件

こちらもご覧ください

WDF_USB_DEVICE_INFORMATION

WdfUsbTargetDeviceCreateWithParameters

WdfUsbTargetDeviceQueryUsbCapability