FILTER_SET_MODULE_OPTIONS コールバック関数 (ndis.h)

  • [アーティクル]

FilterSetModuleOptions 関数は、指定されたフィルター モジュールに関連付けられているオプションのサービスのセットを変更します。

メモFILTER_SET_MODULE_OPTIONS型を使用して関数を宣言する必要があります。 詳細については、次の例に関するセクションを参照してください。
 

構文

FILTER_SET_MODULE_OPTIONS FilterSetModuleOptions;

NDIS_STATUS FilterSetModuleOptions(
  [in] NDIS_HANDLE FilterModuleContext
)
{...}

パラメーター

[in] FilterModuleContext

この要求のターゲットであるフィルター モジュールのコンテキスト領域へのハンドル。 FilterAttach 関数でこのコンテキスト領域を作成および初期化したフィルター ドライバー。

戻り値

FilterSetModuleOptions は、 次のいずれかの状態値を返します。

リターン コード 説明
NDIS_STATUS_SUCCESS
 FilterSetModuleOptions は、 フィルター モジュールのオプションのサービスとリソースを正常に登録しました。
NDIS_STATUS_RESOURCES
 FilterSetModuleOptions は、 フィルター モジュールに必要なリソースを割り当てませんでした。
NDIS_STATUS_ XXX または NTSTATUS_ XXX
 フィルター ドライバーによるオプションの登録に失敗しました。 通常、このようなエラー状態は 、NdisXxx 関数またはカーネル モード サポート ルーチンから伝達されます。

注釈

FilterSetModuleOptions が定義されている場合、NDIS は FilterSetModuleOptions を呼び出してから、FilterRestart 関数を呼び出してフィルター モジュールを開始します。

フィルター ドライバーは、 に渡すNDIS_FILTER_DRIVER_CHARACTERISTICS構造体の変更可能なフィルター モジュール オプションの既定値を指定します。ドライバーの初期化中の NdisFRegisterFilterDriver 関数。

実行時に特定のフィルター モジュールのオプションを変更するには、フィルター ドライバーで FilterSetModuleOptions のエントリ ポイントも指定する必要があります。 NDIS_FILTER_DRIVER_CHARACTERISTICS 構造体。

変更する必要があるオプションを指定するために、 FilterSetModuleOptions は特性構造を定義し、 NdisSetOptionalHandlers 関数を呼び出します。 フィルター ドライバーは、別のスレッドから NdisSetOptionalHandlers を 呼び出してはなりません。

FilterSetModuleOptions から指定できる特性構造は次のとおりです。

NDIS_FILTER_PARTIAL_CHARACTERISTICS NDIS_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS NDIS_CLIENT_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS NDIS_PROVIDER_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS NDIS_PROVIDER_CHIMNEY_OFFLOAD_TCP_CHARACTERISTICS

最後の 4 つの構造体の詳細については、 NDIS 6.0 TCP のチムニー オフロードに関するドキュメントを参照してください。

各特性構造で指定されるオプションは、フィルター・モジュールごとに異なる場合があります。

NDIS が FilterDetach 関数を呼び出すと、フィルター ドライバーは FilterSetModuleOptions で実行されたすべての操作を元に戻す必要があります。

NDIS は、IRQL = PASSIVE_LEVELで FilterSetModuleOptions を呼び出します。

例

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

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

FILTER_SET_MODULE_OPTIONS MySetModuleOptions;

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

_Use_decl_annotations_
NDIS_STATUS
 MySetModuleOptions(
    NDIS_HANDLE  FilterModuleContext
    )
  {...}

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

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

要件

要件 値
サポートされている最小のクライアント NDIS 6.0 以降でサポートされています。
対象プラットフォーム Windows
ヘッダー ndis.h (Ndis.h を含む)
IRQL PASSIVE_LEVEL

こちらもご覧ください

FilterRestart

NDIS_FILTER_DRIVER_CHARACTERISTICS NDIS_FILTER_PARTIAL_CHARACTERISTICS

NdisFRegisterFilterDriver

NdisSetOptionalHandlers