IO_WORKITEM_ROUTINE コールバック関数 (wdm.h)
WorkItem ルーチンは、IoQueueWorkItem ルーチンによってキューに登録された作業項目の処理を実行します。
構文
IO_WORKITEM_ROUTINE IoWorkitemRoutine;
void IoWorkitemRoutine(
[in] PDEVICE_OBJECT DeviceObject,
[in, optional] PVOID Context
)
{...}
パラメーター
[in] DeviceObject
呼び出し元のデバイス オブジェクトの 1 つへのポインター。 これは、作業項目が割り当てられたときに DeviceObject パラメーターとして IoAllocateWorkItem に渡されたポインター、または作業項目が初期化されたときに IoInitializeWorkItem への IoObject パラメーターとして渡されたポインターです。
[in, optional] Context
ドライバー固有のコンテキスト情報を指定します。 これは、作業項目がキューに登録されたときに Context パラメーターとして IoQueueWorkItem に渡された値です。
戻り値
なし
解説
ドライバーは IoQueueWorkItem を呼び出して WorkItem ルーチンをキューに入れ、システム ワーカー スレッドはその後ルーチンを実行します。 WorkItem ルーチンは、限られた時間だけ実行する必要があります。そうしないと、システムがデッドロックする可能性があります。 詳細については、「 システム ワーカー スレッド」を参照してください。
WorkItem ルーチンは、IRQL = PASSIVE_LEVELおよびシステム スレッド コンテキストで実行されます。
例
WorkItem コールバック ルーチンを定義するには、まず、定義するコールバック ルーチンの種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。
たとえば、 という名前MyWorkItemの WorkItem コールバック ルーチンを定義するには、次のコード例に示すように、IO_WORKITEM_ROUTINE型を使用します。
IO_WORKITEM_ROUTINE MyWorkItem;
次に、コールバック ルーチンを次のように実装します。
_Use_decl_annotations_
VOID
MyWorkItem(
PDEVICE_OBJECT DeviceObject,
PVOID Context
)
{
// Function body
}
IO_WORKITEM_ROUTINE関数の種類は、Wdm.h ヘッダー ファイルで定義されます。 コード分析ツールを実行するときにエラーをより正確に識別するには、必ず注釈を _Use_decl_annotations_ 関数定義に追加してください。 注釈を _Use_decl_annotations_ 使用すると、ヘッダー ファイル内のIO_WORKITEM_ROUTINE関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 WDM ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 の詳細 _Use_decl_annotations_については、「 関数の動作に注釈を付ける」を参照してください。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | デスクトップ |
| Header | wdm.h (Wdm.h、Ntddk.h、Ntifs.h を含む) |
| IRQL | PASSIVE_LEVELで呼び出されます。 |