FILTER_PAUSE コールバック関数 (ndis.h)
NDIS は、フィルター ドライバーの FilterPause 関数を呼び出して、指定したフィルター モジュールの一時停止操作を開始します。
構文
FILTER_PAUSE FilterPause;
NDIS_STATUS FilterPause(
[in] NDIS_HANDLE FilterModuleContext,
[in] PNDIS_FILTER_PAUSE_PARAMETERS PauseParameters
)
{...}
パラメーター
[in] FilterModuleContext
フィルター ドライバーが一時停止するフィルター モジュールのコンテキスト領域へのハンドル。 フィルター ドライバーは、 FilterAttach 関数でこのコンテキスト領域を作成および初期化しました。
[in] PauseParameters
へのポインター NDIS_FILTER_PAUSE_PARAMETERS フィルター モジュールの一時停止パラメーターを定義する構造体です。
戻り値
NDIS ドライバーは、一時停止要求を失敗できません。 フィルター ドライバーは、発生したエラーの理由を指定するパラメーターと共に NdisWriteEventLogEntry 関数を呼び出す必要があります。
リターン コード | 説明 |
---|---|
|
FilterPause は、指定されたフィルター モジュールを正常に一時停止しました。 |
|
フィルター ドライバーは、 NdisFPauseComplete 関数の呼び出しで非同期的に要求を完了します。 |
注釈
FilterPause は必須の関数です。 フィルター モジュールが実行中の状態の場合、NDIS は FilterPause を呼び出すことができます。 フィルター モジュールは、FilterPause 関数の実行開始時に一時停止状態になります。
フィルター ドライバーは、NDIS が FilterPause を呼び出すときに次の操作を実行します。
- を呼び出す必要があります。 NdisFSendNetBufferListsComplete 関数は、上にあるドライバーが作成したキューに入っている送信バッファーに対するものです。
- を呼び出す必要があります。基になるドライバーが作成したキューに登録された受信バッファーの NdisFReturnNetBufferLists 関数。
- ドライバーがに送信したすべての未処理の送信要求を返す NDIS を待機する必要があります。 FilterSendNetBufferListsComplete 関数。
- NDIS が未処理のすべての受信通知を返すのを待機する必要があります。 FilterReturnNetBufferLists 関数。
一時停止状態または一時停止状態では、フィルター ドライバーは OID 要求または状態表示を引き続き処理する必要があります。 ドライバーは、 の呼び出しを拒否する必要があります。 FilterSendNetBufferLists 関数。 ドライバーは、 への呼び出しを渡すことができます。 FilterReceiveNetBufferLists 関数。 ただし、ドライバーは、作成したバッファーを渡すことはできません。 ドライバーは、受信通知を生成したり、要求を送信したりしてはなりません。
一時停止状態では、フィルター モジュールは送信要求を生成したり、通知を受信したりしてはなりません。
NDIS は FilterRestart 関数を呼び出して、 一時停止 状態のフィルター モジュールの再起動要求を開始します。
NDIS は、IRQL = PASSIVE_LEVEL で FilterPause を呼び出します。
例
FilterPause 関数を定義するには、まず、定義する関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーの関数型のセットが用意されています。 関数の種類を使用して関数を宣言すると、 ドライバーのコード分析、 静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。たとえば、"MyPause" という名前の FilterPause 関数を定義するには、次のコード例に示すように 、FILTER_PAUSE 型を使用します。
FILTER_PAUSE MyPause;
次に、次のように関数を実装します。
_Use_decl_annotations_
NDIS_STATUS
MyPause(
NDIS_HANDLE FilterModuleContext,
PNDIS_FILTER_PAUSE_PARAMETERS FilterPauseParameters
)
{...}
FILTER_PAUSE関数の種類は、Ndis.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のFILTER_PAUSE関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「NDIS ドライバーの関数 ロール型を使用して関数を宣言する」を参照してください。
Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | NDIS 6.0 以降でサポートされています。 |
対象プラットフォーム | Windows |
ヘッダー | ndis.h (Ndis.h を含む) |
IRQL | PASSIVE_LEVEL |