FwpmFilterEnum0 関数 (fwpmu.h)

  • [アーティクル]

FwpmFilterEnum0 関数は、フィルター列挙子から結果の次のページを返します。

構文

DWORD FwpmFilterEnum0(
  [in]  HANDLE       engineHandle,
  [in]  HANDLE       enumHandle,
  [in]  UINT32       numEntriesRequested,
  [out] FWPM_FILTER0 ***entries,
  [out] UINT32       *numEntriesReturned
);

パラメーター

[in] engineHandle

型: HANDLE

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

[in] enumHandle

型: HANDLE

FwpmFilterCreateEnumHandle0 の呼び出しによって作成されたフィルター列挙のハンドル。

[in] numEntriesRequested

種類: UINT32

要求されたフィルター オブジェクトの数。

[out] entries

種類: FWPM_FILTER0***

列挙エントリのアドレス。

[out] numEntriesReturned

型: UINT32*

返されるフィルター オブジェクトの数。

戻り値

型: DWORD

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

解説

numEntriesReturned が numEntriesRequested より小さい場合、列挙体は使い果たされます。

返されるエントリの配列 (個々のエントリ自体ではなく) は 、FwpmFreeMemory0 の呼び出しによって解放する必要があります。

同じ列挙ハンドルを使用する後続の呼び出しでは、最後の出力バッファー内の項目に続く項目の次のセットが返されます。

FwpmFilterEnum0 は、列挙ハンドルの作成時に取得されたフィルターのスナップショットで機能します。

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

要件

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

関連項目

FWPM_FILTER0

FwpmFilterCreateEnumHandle0