WdfUsbTargetPipeWdmGetPipeHandle 関数 (wdfusb.h)

[KMDF にのみ適用]

WdfUsbTargetPipeWdmGetPipeHandle メソッドは、指定されたフレームワーク パイプ オブジェクトに関連付けられているUSBD_PIPE_HANDLE型指定されたハンドルを返します。

構文

USBD_PIPE_HANDLE WdfUsbTargetPipeWdmGetPipeHandle(
  [in] WDFUSBPIPE UsbPipe
);

パラメーター

[in] UsbPipe

WdfUsbInterfaceGetConfiguredPipe を呼び出して取得されたフレームワーク パイプ オブジェクトへのハンドル。

戻り値

WdfUsbTargetPipeWdmGetPipeHandle は、USBD_PIPE_HANDLE型指定のハンドルを返します。

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

注釈

フレームワーク ベースのドライバーは、パイプ ハンドルを必要とする URB を 作成する場合にのみ、USBD_PIPE_HANDLE型のハンドルを取得する必要があります。

WdfUsbTargetDeviceSelectConfig を呼び出した後、ドライバーは WdfUsbTargetPipeWdmGetPipeHandle メソッドを呼び出すことができます。 WdfUsbTargetPipeWdmGetPipeHandle が返すUSBD_PIPE_HANDLE型指定のハンドルは、ドライバーが WdfUsbTargetDeviceSelectConfig を再度呼び出すか、ドライバーが WdfUsbInterfaceSelectSetting を呼び出すか、フレームワーク パイプ オブジェクトが削除されるまで有効です。 ドライバーがフレームワーク パイプ オブジェクトの EvtCleanupCallback 関数を提供し、ドライバーが WdfUsbTargetDeviceSelectConfig を再度呼び出す前にオブジェクトが削除された場合、または WdfUsbInterfaceSelectSetting を呼び出す場合、ハンドルはオブジェクトの EvtCleanupCallback 関数が返されるまで有効です。

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

例

次のコード例では、指定したパイプのUSBD_PIPE_HANDLE型指定されたハンドルを取得します。

USBD_PIPE_HANDLE  usbdPipeHandle;

usbdPipeHandle = WdfUsbTargetPipeWdmGetPipeHandle(UsbPipe);

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
Header	wdfusb.h (Wdfusb.h を含む)
Library	Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。
IRQL	<=DISPATCH_LEVEL
DDI コンプライアンス規則	DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 UsbKmdfIrql(kmdf)、 UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf)

こちらもご覧ください

Urb

WdfUsbInterfaceGetConfiguredPipe

WdfUsbTargetDeviceSelectConfig