WdfUsbTargetPipeResetSynchronously 関数 (wdfusb.h)
[KMDF と UMDF に適用]
WdfUsbTargetPipeResetSynchronously メソッドはリセット要求をビルドし、指定された USB パイプに同期的に送信します。
構文
NTSTATUS WdfUsbTargetPipeResetSynchronously(
[in] WDFUSBPIPE Pipe,
[in, optional] WDFREQUEST Request,
[in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions
);
パラメーター
[in] Pipe
WdfUsbInterfaceGetConfiguredPipe を呼び出して取得されたフレームワーク パイプ オブジェクトへのハンドル。
[in, optional] Request
フレームワーク要求オブジェクトへのハンドル。 このパラメーターは省略可能であり、 NULL にすることができます。 詳細については、「解説」を参照してください。
[in, optional] RequestOptions
要求のオプションを指定する呼び出し元によって割り当てられた WDF_REQUEST_SEND_OPTIONS 構造体へのポインター。 このポインターは省略可能であり、 NULL にすることができます。 詳細については、「解説」を参照してください。
戻り値
操作が成功した場合、WdfUsbTargetPipeResetSynchronously は USB I/O ターゲットの完了状態値を返します。 それ以外の場合、このメソッドは次のいずれかの値を返すことができます。
リターン コード | 説明 |
---|---|
|
RequestOptions パラメーターが指定したWDF_REQUEST_SEND_OPTIONS構造体のサイズが正しくありません。 |
|
無効なパラメーターが検出されました。 |
|
メモリが不足していました。 |
|
呼び出し元の IRQL がPASSIVE_LEVELされていないか、指定された Request パラメーターが既に I/O ターゲットにキューに入れられていた I/O 要求。 |
|
ドライバーはタイムアウト値を指定し、割り当てられた時間内に要求が完了しませんでした。 |
|
要求パラメーターが表す I/O 要求パケット (IRP) は、ドライバーが 要求 を転送できるようにするため の十 分なIO_STACK_LOCATION構造を提供しません。 |
このメソッドは、他の NTSTATUS 値を返す場合もあります。
ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。
注釈
USB リセット要求を同期的に送信するには、 WdfUsbTargetPipeResetSynchronously メソッドを使用します。 このような要求を非同期で送信するには、 WdfUsbTargetPipeFormatRequestForReset を使用し、その後に WdfRequestSend を使用します。
フレームワークは、I/O ターゲットの USB パイプをリセットする前に、I/O ターゲットのキューに残っているすべての I/O 要求を取り消します。 WdfUsbTargetPipeResetSynchronously が返されるまで、ドライバーは追加の I/O 要求を I/O ターゲットに送信しないでください。
ドライバーは WdfUsbTargetPipeResetSynchronously を呼び出す前に WdfIoTargetStop を呼び出す必要があります。 WdfUsbTargetPipeResetSynchronously が返された後、ドライバーは WdfIoTargetStart を呼び出すことができます。
ドライバーが WdfUsbTargetPipeResetSynchronously を呼び出すと、フレームワークは I/O ターゲットに URB_FUNCTION_RESET_PIPE 要求を送信します。 USB パイプのリセットの詳細については、USB 仕様に関するページを参照してください。
WdfUsbTargetPipeResetSynchronously メソッドは、要求が完了するまで、RequestOptions パラメーターが指すWDF_REQUEST_SEND_OPTIONS構造体にタイムアウト値を指定しない限り、またはエラーが検出されない限り、戻りません。
ドライバーが I/O キューで受信した I/O 要求を転送することも、新しい要求を作成して送信することもできます。
ドライバーが I/O キューで受信した I/O 要求を転送するには、 WdfUsbTargetPipeResetSynchronously メソッドの Request パラメーターに対して、受信した 要求 のハンドルを指定します。
新しい要求を作成して送信するには、Request パラメーターに NULL 要求ハンドルを指定するか、新しい要求オブジェクトを作成してそのハンドルを指定します。
- NULL 要求ハンドルを指定すると、フレームワークは内部要求オブジェクトを使用します。 この手法は簡単に使用できますが、ドライバーは要求をキャンセルできません。
- WdfRequestCreate を呼び出して 1 つ以上の要求オブジェクトを作成する場合は、WdfRequestReuse を呼び出すことで、これらの要求オブジェクトを再利用できます。 この手法を使用すると、ドライバーの EvtDriverDeviceAdd コールバック関数を使用して、デバイスの要求オブジェクトを事前に割り当てできます。 さらに、別のドライバー スレッドは WdfRequestCancelSentRequest を呼び出して、必要に応じて要求を取り消すことができます。
I/O 要求の完了後に状態情報を取得する方法については、「 完了情報の取得」を参照してください。
WdfUsbTargetPipeResetSynchronously メソッドと USB I/O ターゲットの詳細については、「USB I/O ターゲット」を参照してください。
例
次のコード例では、USB デバイスのパイプにリセット要求を送信します。
NTSTATUS status;
status = WdfUsbTargetPipeResetSynchronously(
Pipe,
WDF_NO_HANDLE,
NULL
);
要件
要件 | 値 |
---|---|
対象プラットフォーム | ユニバーサル |
最小 KMDF バージョン | 1.0 |
最小 UMDF バージョン | 2.0 |
Header | wdfusb.h (Wdfusb.h を含む) |
Library | Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF) |
IRQL | PASSIVE_LEVEL |
DDI コンプライアンス規則 | DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 RequestForUrbXrb(kmdf)、 UsbKmdfIrql(kmdf)、 UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf) |
こちらもご覧ください
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示