WdfRequestIsCanceled 関数 (wdfrequest.h)
[KMDF と UMDF に適用]
WdfRequestIsCanceled メソッドは、I/O マネージャーが指定した I/O 要求を取り消そうとしたかどうかを判断します。
構文
BOOLEAN WdfRequestIsCanceled(
[in] WDFREQUEST Request
);
パラメーター
[in] Request
フレームワーク要求オブジェクトへのハンドル。
戻り値
I/O マネージャーが指定した I/O 要求を取り消そうとした場合、WdfRequestIsCanceled は TRUE を返します。 呼び出し元のドライバーが要求を所有していない場合でも、このメソッドは TRUE を 返す場合があります。 ドライバーが要求を所有していない場合は、 WdfRequestIsCanceled を呼び出さないでください。 「備考」の追加情報を参照してください。
WdfRequestIsCanceled は、次のいずれかの理由で FALSE を 返します。
- I/O マネージャーが要求を取り消そうとしていません。
- 呼び出し元のドライバーが要求を所有していません。
- 呼び出し元のドライバーは 、WdfRequestMarkCancelable メソッドまたは WdfRequestMarkCancelableEx メソッドを呼び出しました。
ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。
注釈
ドライバーが WdfRequestMarkCancelable または WdfRequestMarkCancelableEx を呼び出して EvtRequestCancel コールバック関数を登録していないが、I/O マネージャーが I/O 要求を取り消そうとしたかどうかをドライバーが判断する場合、ドライバーは WdfRequestIsCanceled を呼び出すことができます。
ドライバーが WdfRequestMarkCancelable または WdfRequestMarkCancelableEx を呼び出した場合は、 WdfRequestIsCanceled を呼び出す前に WdfRequestUnmarkCancelable を呼び出 す必要があります。
ドライバーは、ドライバーが I/O 要求を所有している場合にのみ、要求に対して WdfRequestIsCanceled を呼び出すことができます。
WdfRequestIsCanceled がTRUE を返した場合、ドライバーは STATUS_CANCELLED の Status パラメーターを使用して WdfRequestComplete を呼び出して要求を取り消す必要があります。 ドライバーが所有していない要求を完了しようとすると、ドライバーによってシステムがクラッシュする可能性があります。
WdfRequestIsCanceled の詳細については、「I/O 要求の取り消し」を参照してください。
例
次のコード例では、WdfRequestIsCanceled が TRUE を返す場合に WdfRequestComplete を呼び出します。
if (WdfRequestIsCanceled(request)) {
WdfRequestComplete(
request,
STATUS_CANCELLED
);
}
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | ユニバーサル |
| 最小 KMDF バージョン | 1.0 |
| 最小 UMDF バージョン | 2.0 |
| Header | wdfrequest.h (Wdf.h を含む) |
| Library | Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF) |
| IRQL | <=DISPATCH_LEVEL |
| DDI コンプライアンス規則 | DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 ReqIsCancOnCancReq(kmdf) |