FwpmBfeStateSubscribeChanges0 関数 (fwpmk.h)

[アーティクル]
07/16/2024

FwpmBfeStateSubscribeChanges0 関数は、フィルターエンジンの状態が変更されるたびに呼び出されるコールバック関数を登録します。

警告

コールバック パラメーター渡したコールバック関数から FwpmBfeStateUnsubscribeChanges0 を呼び出さないでください。これを行うと、デッドロックが発生する可能性があります。

構文

NTSTATUS FwpmBfeStateSubscribeChanges0(
  [in, out]      void                                *deviceObject,
  [in]           FWPM_SERVICE_STATE_CHANGE_CALLBACK0 callback,
  [in, optional] void                                *context,
  [out]          HANDLE                              *changeHandle
);

パラメーター

[in, out] deviceObject

吹き出しドライバーによって以前に作成されたデバイスオブジェクトへのポインター。吹き出しドライバーがデバイスオブジェクトを作成する方法の詳細については、「デバイスオブジェクトの作成を参照してください。

[in] callback

コールアウトドライバーが提供するサービス状態変更コールバック関数へのポインター。フィルターエンジンは、フィルターエンジンの状態が変化するたびに、この関数を呼び出します。

サービス状態変更コールバック関数は、次のように宣言されます。

VOID NTAPI
callback(
    IN OUT void  *context,
    IN FWPM_SERVICE_STATE  newState
    );

文脈

コールアウトドライバーが FwpmBfeStateSubscribeChanges0 関数を呼び出したときに、Context パラメーターで渡されたポインター。

newState

フィルターエンジンの新しい状態。このパラメーターには、次のいずれかの値が含まれています。

FWPM_SERVICE_STOPPED

フィルターエンジンが実行されていません。

FWPM_SERVICE_START_PENDING

フィルターエンジンが起動しています。

FWPM_SERVICE_STOP_PENDING

フィルターエンジンが停止しています。

FWPM_SERVICE_RUNNING

フィルターエンジンが実行されています。

[in, optional] context

Callback パラメーターで指定されたコールバック関数に渡される、コールアウトドライバーが提供するコンテキストへのポインター。

[out] changeHandle

コールバック関数の登録に関連付けられているハンドルを受け取る変数へのポインター。コールアウトドライバーは、このハンドルを FwpmBfeStateUnsubscribeChanges0 関数に渡して、コールバック関数を登録解除します。

戻り値

FwpmBfeStateSubscribeChanges0 関数は、次のいずれかの NTSTATUS コードを返します。

リターンコード	形容
STATUS_SUCCESS	コールバック関数が正常に登録されました。
その他の NTSTATUS コード	エラーが発生しました。

備考

コールアウトドライバーは、FwpmBfeStateSubscribeChanges0 関数を呼び出して、フィルターエンジンの状態が変化するたびに呼び出されるコールバック関数を登録します。

たとえば、コールアウトドライバーは、フィルターエンジンが現在実行中でない限り、FwpmEngineOpen0 関数を呼び出すことによって、フィルターエンジンへのセッションを開くことができません。コールアウトドライバーは、FWPM_SERVICE_RUNNING 通知を使用してフィルターエンジンへのセッションを開き、他の Windows フィルタープラットフォーム管理機能を呼び出すことができます。同様に、コールアウトドライバーは、フィルターエンジンが停止する前に、FWPM_SERVICE_STOP_PENDING 通知を使用してクリーンアップを実行できます。

コールアウトドライバーは、FwpmBfeStateGet0 関数を呼び出してフィルターエンジンの現在の状態を取得する前に、FwpmBfeStateSubscribeChanges0 呼び出す必要があります。 FwpmBfeStateSubscribeChanges0 呼び出しが戻った後、コールアウトドライバーは、いつでも fwpmBfeStateGet0 呼び出すことができます。

コールアウトドライバーをアンロードする前に、FwpmBfeStateUnsubscribeChanges0 関数を呼び出すことによって、コールアウトドライバーでコールバック関数の登録を解除する必要があります。

FwpmBfeStateSubscribeChanges0 は、FwpmBfeStateSubscribeChangesの特定のバージョンです。詳細については、「WFP Version-Independent 名のと Windows の特定のバージョンを対象とする」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows Vista 以降で使用できます。
ターゲットプラットフォームの	万国
ヘッダー	fwpmk.h (Fwpmk.h を含む)
ライブラリ	Fwpkclnt.lib
IRQL	PASSIVE_LEVEL

次の方法で共有