FwpmEngineOpen0 関数 (fwpmk.h)

[アーティクル]
02/29/2024

FwpmEngineOpen0 関数は、フィルターエンジンへのセッションを開きます。

注意

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

構文

NTSTATUS FwpmEngineOpen0(
  [in, optional] const wchar_t             *serverName,
  [in]           UINT32                    authnService,
  [in, optional] SEC_WINNT_AUTH_IDENTITY_W *authIdentity,
  [in, optional] const FWPM_SESSION0       *session,
  [out]          HANDLE                    *engineHandle
);

パラメーター

[in, optional] serverName

フィルターエンジンへのセッションを開くシステムの標準 DNS 名を指定する NULL で終わる文字列へのポインター。コールアウトドライバーでは、このパラメーターに NULL を 指定する必要があります。

[in] authnService

使用する認証サービス。このパラメーターの有効な選択肢の一覧については、Microsoft Windows SDKドキュメントの RPC セクションの「Authentication-Service 定数」を参照してください。吹き出しドライバーでは、このパラメーターにRPC_C_AUTHN_WINNTまたはRPC_C_AUTHN_DEFAULTを指定する必要があります。

[in, optional] authIdentity

フィルターエンジンにアクセスするための認証と承認の資格情報を含む SEC_WINNT_AUTH_IDENTITY_W 構造体へのポインター。 FwpmEngineOpen0 関数がコールアウトドライバーから呼び出されると、このパラメーターは無視されます。コールアウトドライバーでは、このパラメーターを NULL に設定する必要があります。

[in, optional] session

開いているセッションのセッション固有のパラメーターを定義する FWPM_SESSION0 構造体へのポインター。このポインターは省略可能であり、 NULL にすることができます。

[out] engineHandle

フィルターエンジンへの開いているセッションのハンドルを受け取る変数へのポインター。

戻り値

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

リターンコード	説明
STATUS_SUCCESS	フィルターエンジンへのセッションが正常に開かれました。 engineHandle パラメーターが指す変数には、開いているセッションのハンドルが含まれています。
その他の状態コード	エラーが発生しました。

解説

コールアウトドライバーは FwpmEngineOpen0 関数を呼び出して、フィルターエンジンへのセッションを開きます。フィルターエンジンへの開いているセッションへのハンドルは、ほとんどの Windows フィルタープラットフォーム管理機能に必要なパラメーターです。

コールアウトドライバーは通常、 Windows フィルタープラットフォーム管理機能を呼び出さないので、通常、フィルターエンジンへのセッションを開く必要はありません。

吹き出しドライバーがフィルターエンジンへのセッションを正常に開くには、コールアウトドライバーが FwpmEngineOpen0 関数を呼び出す時点で、フィルターエンジンが現在実行されている必要があります。コールアウトドライバーは、FwpmBfeStateGet0 関数を呼び出して、フィルターエンジンの現在の状態を取得できます。 FwpmBfeStateGet0 を呼び出す前に、コールアウトドライバーは FwpmBfeStateSubscribeChanges0 関数を呼び出して、フィルターエンジンの状態が変化するたびに呼び出されるコールバック関数を登録する必要があります。

コールアウトドライバーは、フィルターエンジンへのアクセスが完了すると、 FwpmEngineClose0 関数を呼び出して、フィルターエンジンへの開いているセッションを閉じます。

要件

要件	値
サポートされている最小のクライアント	Windows Vista 以降で使用できます。
対象プラットフォーム	ユニバーサル
Header	fwpmk.h (Fwpmk.h を含む)
Library	Fwpkclnt.lib
IRQL	PASSIVE_LEVEL