FwpmEngineSetOption0 関数 (fwpmk.h)

  • [アーティクル]

FwpmEngineSetOption0 関数は、フィルター エンジンの設定を変更します。

構文

NTSTATUS FwpmEngineSetOption0(
  [in] HANDLE             engineHandle,
  [in] FWPM_ENGINE_OPTION option,
  [in] const FWP_VALUE0   *newValue
);

パラメーター

[in] engineHandle

フィルター エンジンへの開いているセッションのハンドル。 FwpmEngineOpen0 を呼び出して、フィルター エンジンへのセッションを開きます。

[in] option

設定するオプション。

[in] newValue

新しいオプション値。 newValue パラメーターに含まれるデータ型は FWP_UINT32する必要があります。

オプション が FWPM_ENGINE_COLLECT_NET_EVENTSされている場合は、newValue 次のいずれかになります。

価値 意味
0 ネットワーク イベントを収集しないでください。
1 ネットワーク イベントを収集します。 これが既定の設定です。

オプション が FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDSされている場合、newValue は 0 (ゼロ) または次の値のビットごとの組み合わせにする必要があります。

手記

newValue 0 の場合、受信マルチキャストイベントとブロードキャスト イベントのコレクションは無効になります。 これが既定の設定です。

価値 意味
FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST
1		 受信マルチキャスト ネットワーク イベントを収集します。
FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST
2		 受信ブロードキャスト ネットワーク イベントを収集します。

オプション が FWPM_ENGINE_PACKET_QUEUING されている場合 (Windows 8 および Windows Server 2012 でのみ使用できます)、newValue 次のいずれかである必要があります。

価値 意味
FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE
0		 パケット キューを有効にしないでください。
FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND
1		 受信パケット キューを有効にします。
FWPM_ENGINE_OPTION_PACKET_QUEUE_OUTBOUND
2		 送信パケット キューを有効にします。

オプション が FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS されている場合 (Windows 8 および Windows Server 2012 でのみ使用できます)、newValue 次のようになります。 (FwpmEngineSetOption0 を使用して接続を有効にすることができますが、無効にしようとするとエラー FWP_E_STILL_ON で失敗します)。

価値 意味
1 IPsec 接続監視機能が有効になります。 新しい IPsec 接続イベントがログに記録され、通知が送信されます。

オプション が FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC されている場合 (Windows 8 および Windows Server 2012 でのみ使用可能)、newValue は、単一の WFP トランザクションの最大期間を指定する時間 (ミリ秒単位) にする必要があります。 この期間を超えるトランザクションでは、ウォッチドッグ イベントがトリガーされます。

FWPM_ENGINE_NAME_CACHE オプションは、内部使用のために予約されています。

戻り値

戻りコード/値 形容
ERROR_SUCCESS
0		 成功
FWP_E_* エラー コードの
0x80320001 — 0x80320039		 Windows フィルタリング プラットフォーム (WFP) 固有のエラー。 詳細については、「WFP エラー コードの」を参照してください。
RPC_* エラー コードの
0x80010001 — 0x80010122		 リモートまたはローカルのファイアウォール エンジンとの通信に失敗しました。
その他の NTSTATUS コード エラーが発生しました。

備考

この関数はトランザクション内から呼び出すことはできません。FWP_E_TXN_IN_PROGRESSで失敗します。 トランザクションの詳細については、オブジェクト管理 の を参照してください。

この関数は動的セッション内から呼び出すことはできません。FWP_E_DYNAMIC_SESSION_IN_PROGRESSで失敗します。 セッションの詳細については、「オブジェクト管理 を参照してください。

呼び出し元は、フィルター エンジン FWPM_ACTRL_WRITE アクセスする必要があります。 詳細については、「アクセス制御の」を参照してください。

ネットワーク イベント収集の既定の設定は次のとおりです。

  • 送信、すべての (ユニキャスト、マルチキャスト、ブロードキャスト) イベントが収集されます。
  • 受信、ユニキャスト イベントのみが収集されます。

ネットワーク イベント収集の設定は、再起動後も保持されます。

受信ブロードキャストまたはマルチキャスト ネットワーク イベントを収集するには、次の処理を行います。

  1. オプションを に設定し、newValue を 1 に設定 、FwpmEngineSetOption0 呼び出します。
  2. オプションを に設定し、newValue パラメーターを または に設定 、FwpmEngineSetOption0 を呼び出します。

受信ブロードキャストまたはマルチキャスト ネットワーク イベントの収集を停止するには、

  • オプションを に設定し、newValue パラメーターを 0 (ゼロ) に設定 FwpmEngineSetOption0 を呼び出します。

ネットワーク イベント 収集 (FWPM_ENGINE_COLLECT_NET_EVENTS) を無効にして再度有効にしても、受信ブロードキャスト イベントとマルチキャスト イベントのコレクションはリセットされません。

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

必要条件

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

関連項目