WdfUsbTargetPipeAbortSynchronously 関数 (wdfusb.h)
[KMDF と UMDF に適用]
WdfUsbTargetPipeAbortSynchronously メソッドは中止要求をビルドし、指定された USB パイプに同期的に送信します。
構文
NTSTATUS WdfUsbTargetPipeAbortSynchronously(
[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
戻り値
WdfUsbTargetPipeAbortSynchronously 操作が成功した場合、I/O ターゲットの完了状態の値を返します。 それ以外の場合、このメソッドは次のいずれかの値を返すことができます。
リターン コード | 形容 |
---|---|
|
RequestOptions パラメーターが指定した WDF_REQUEST_SEND_OPTIONS 構造体のサイズが正しくありません。 |
|
無効なハンドルが検出されました。 |
|
メモリが不足していました。 |
|
呼び出し元の IRQL がPASSIVE_LEVELされていないか、指定された I/O 要求が既に I/O ターゲットにキューに登録されています。 |
|
ドライバーがタイムアウト値を指定し、割り当てられた時間内に要求が完了しませんでした。 |
このメソッドは、他の
ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。
備考
WdfUsbTargetPipeAbortSynchronously メソッドを使用して、USB 中止要求を同期的に送信します。 このような要求を非同期に送信するには、
USB 中止要求により、ドライバーの I/O ターゲットは、パイプに送信されたすべての I/O 要求を取り消します。 ドライバーが WdfUsbTargetPipeAbortSynchronously
WdfUsbTargetPipeAbortSynchronously メソッドは、RequestOptions パラメーターの WDF_REQUEST_SEND_OPTIONS 構造体にタイムアウト値を指定しない限り、またはエラーが検出されない限り、要求が完了するまで戻りません。
ドライバーが I/O キューで受信した I/O 要求を転送することも、新しい要求を作成して送信することもできます。
ドライバーが I/O キューで受信した I/O 要求を転送するには、WdfUsbTargetPipeAbortSynchronously メソッドの Request パラメーターに対して受信した要求のハンドル 指定します。
新しい要求を作成して送信するには、Request パラメーターに対して NULL 要求ハンドルを指定するか、新しい要求オブジェクトを作成してそのハンドルを指定します。
- NULL 要求ハンドルを指定すると、フレームワークは内部要求オブジェクトを使用します。 この手法は簡単に使用できますが、ドライバーは要求をキャンセルできません。
-
WdfRequestCreate を呼び出して 1 つ以上の要求オブジェクトを作成する場合は、WdfRequestReuse呼び出すことによって、これらの要求オブジェクトを再利用できます。 この手法を使用すると、ドライバーの EvtDriverDeviceAdd コールバック関数を使用して、デバイスの要求オブジェクトを事前に割り当てることができます。 さらに、別のドライバー スレッドは、WdfRequestCancelSentRequest を呼び出して、必要に応じて要求を取り消すことができます。
I/O 要求が完了した後の状態情報の取得については、「完了情報の取得を参照してください。
WdfUsbTargetPipeAbortSynchronously メソッドと USB I/O ターゲットの詳細については、「USB I/O ターゲットの」を参照してください。
例
次のコード例では、USB デバイスのインターフェイス用に構成されているすべてのパイプに中止要求を送信します。
UCHAR i;
ULONG count;
NTSTATUS status;
PDEVICE_CONTEXT pDevContext;
pDevContext = GetDeviceContext(Device);
count = WdfUsbInterfaceGetNumConfiguredPipes(
pDevContext->UsbInterface
);
for (i = 0; i < count; i++) {
WDFUSBPIPE pipe;
pipe = WdfUsbInterfaceGetConfiguredPipe(
pDevContext->UsbInterface,
i,
NULL
);
status = WdfUsbTargetPipeAbortSynchronously(
pipe,
WDF_NO_HANDLE,
NULL
);
if (!NT_SUCCESS(status)) {
break;
}
}
必要条件
要件 | 価値 |
---|---|
ターゲット プラットフォーム の |
万国 |
最小 KMDF バージョン | 1.0 |
UMDF の最小バージョン を |
2.0 |
ヘッダー | wdfusb.h (Wdfusb.h を含む) |
ライブラリ | 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) |
関連項目
WdfUsbTargetPipeResetSynchronously を