FwpmEngineSetOption0 関数 (fwpmu.h)

  • [アーティクル]

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

構文

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

パラメーター

[in] engineHandle

型: HANDLE

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

[in] option

種類: FWPM_ENGINE_OPTION

設定するオプション。

[in] newValue

種類: FWP_VALUE0*

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

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

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

option が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 ERROR で失敗します)。

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

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

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

戻り値

型: DWORD

リターン コード/値 Description
ERROR_SUCCESS
0
 オプションが正常に設定されました。
FWP_E_* エラー コード
0x80320001 — 0x80320039
 Windows フィルタリング プラットフォーム (WFP) 固有のエラー。 詳細については、「 WFP エラー コード 」を参照してください。
RPC_* エラー コード
0x80010001 — 0x80010122
 リモートまたはローカルのファイアウォール エンジンとの通信に失敗しました。

解説

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

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

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

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

  • 送信、すべての (ユニキャスト、マルチキャスト、ブロードキャスト) イベントが収集されます。
  • 受信、ユニキャスト イベントのみが収集されます。
ネットワーク イベント収集の設定は、再起動後も保持されます。

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

  1. オプションを FWPM_ENGINE_COLLECT_NET_EVENTS に設定し、newValue を 1 に設定して FwpmEngineSetOption0 を呼び出します。
  2. FwpmEngineSetOption0 を呼び出し、オプションを FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS に設定し、newValue パラメーターを FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST または FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST に設定します。
受信ブロードキャストまたはマルチキャスト ネットワーク イベントの収集を停止するには、次の処理を行います。
  • オプションを FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS に設定し、newValue パラメーターを 0 (ゼロ) に設定して FwpmEngineSetOption0 を呼び出します。
ネットワーク イベント 収集 (FWPM_ENGINE_COLLECT_NET_EVENTS) を無効にして再度有効にしても、受信ブロードキャスト イベントとマルチキャスト イベントのコレクションはリセットされません。

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

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー fwpmu.h
Library Fwpuclnt.lib
[DLL] Fwpuclnt.dll

関連項目

FWPM_ENGINE_OPTION

FWP_VALUE0

FwpmEngineGetOption0