Windows Dev Center

IPsecSaContextCreateEnumHandle0 function

The IPsecSaContextCreateEnumHandle0 function creates a handle used to enumerate a set of IPsec security association (SA) context objects.

Syntax


DWORD IPsecSaContextCreateEnumHandle0(
  _In_           HANDLE                          engineHandle,
  _In_opt_ const IPSEC_SA_CONTEXT_ENUM_TEMPLATE0 *enumTemplate,
  _Out_          HANDLE                          *enumHandle
);

Parameters

engineHandle [in]

Type: HANDLE

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

enumTemplate [in, optional]

Type: const IPSEC_SA_CONTEXT_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

enumHandle [out]

Type: HANDLE*

Address of a HANDLE variable. On function return, it contains the handle for SA context enumeration.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The enumerator was created successfully.

FWP_E_* error code
0x80320001—0x80320039

A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.

RPC_* error code
0x80010001—0x80010122

Failure to communicate with the remote or local firewall engine.

 

Remarks

If enumTemplate is NULL, all IPsec SA objects are returned.

The caller must call IPsecSaContextDestroyEnumHandle0 to free the returned handle.

The caller needs FWPM_ACTRL_ENUM and FWPM_ACTRL_READ access to the IPsec security associations database. See Access Control for more information.

IPsecSaContextCreateEnumHandle0 is a specific implementation of IPsecSaContextCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

IPsecSaContextDestroyEnumHandle0
IPSEC_SA_CONTEXT_ENUM_TEMPLATE0

 

 

Community Additions

ADD
Show:
© 2015 Microsoft