NdisQueueIoWorkItem 関数 (ndis.h)

  • [アーティクル]

NDIS ドライバーは、 NdisQueueIoWorkItem 関数を呼び出して作業項目をキューに入れます。

構文

void NdisQueueIoWorkItem(
  [in] NDIS_HANDLE              NdisIoWorkItemHandle,
  [in] NDIS_IO_WORKITEM_ROUTINE Routine,
  [in] PVOID                    WorkItemContext
);

パラメーター

[in] NdisIoWorkItemHandle

への以前の呼び出しによって返されたプライベート IO_WORKITEM 構造体へのハンドル。 NdisAllocateIoWorkItem 関数。

[in] Routine

NDIS が作業項目を処理するために呼び出す関数へのエントリ ポイント。 NDIS は、システム スレッドのコンテキストでこのルーチンを呼び出します。

メモ 関数は、(NDIS_IO_WORKITEM_ROUTINEではなく) NDIS_IO_WORKITEM_FUNCTION 型を使用して宣言 する必要があります。 詳細については、次の例に関するセクションを参照してください。
 
ルーチンには、次の入力パラメーターが含まれています。

WorkItemContext

ドライバーが NdisQueueIoWorkItem の WorkItemContext パラメーターに渡したコンテキスト領域へのポインター。

NdisIoWorkItemHandle

への以前の呼び出しによって返されたプライベート NDIS_IO_WORKITEM 構造体へのハンドル。 NdisAllocateIoWorkItem 関数。

[in] WorkItemContext

NDIS がコールバック ルーチンに渡す呼び出し元が指定したコンテキスト領域へのポインター。 WorkItemContext には、ドライバーが作業項目を管理するために必要な呼び出し元指定のデータを指定できます。

戻り値

なし

解説

NdisQueueIoWorkItem はIoQueueWorkItem を呼び出して作業項目をキューに入れます。 NDIS 作業項目は 、CriticalWorkQueue キューの種類を使用します。

呼び出し元から提供されたコールバック ルーチン (NDIS_IO_WORKITEM_ROUTINE) は、IRQL = PASSIVE_LEVELのシステム スレッド コンテキストで実行されます。

この呼び出し元から提供されるルーチンは、 NdisFreeIoWorkItem 関数を呼び出して、作業項目に割り当てられたストレージを再利用できます。

例

Routine 関数を定義するには、まず、定義する関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバー用の一連の関数型が用意されています。 関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。

たとえば、"MyWorkitemRoutine" という名前の Routine 関数を定義するには、次のコード例に示すように 、NDIS_IO_WORKITEM_FUNCTION 型を使用します。

NDIS_IO_WORKITEM_FUNCTION MyWorkitemRoutine;

次に、次のように関数を実装します。

_Use_decl_annotations_
VOID
 MyWorkitemRoutine(
    PVOID   WorkItemContext,
    NDIS_HANDLE  NdisIoWorkItemHandle
    )
  {...}

NDIS_IO_WORKITEM_FUNCTION関数の種類は、Ndis.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のNDIS_IO_WORKITEM_FUNCTION関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「NDIS ドライバーの関数 ロール型を使用して関数を宣言する」を参照してください。

Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件 値
サポートされている最小のクライアント NDIS 6.0 以降でサポートされています。
対象プラットフォーム ユニバーサル
Header ndis.h (Ndis.h を含む)
Library Ndis.lib
IRQL <= DISPATCH_LEVEL
DDI コンプライアンス規則 Irql_Miscellaneous_Function(ndis)

こちらもご覧ください

IoQueueWorkItem

MiniportHaltEx

NDIS I/O 作業項目

NdisAllocateIoWorkItem

NdisFreeIoWorkItem