IPsecSaContextEnum1 function

The IPsecSaContextEnum1 function returns the next page of results from the IPsec security association (SA) context enumerator.

Note  IPsecSaContextEnum1 is the specific implementation of IPsecSaContextEnum used in Windows 7 and later. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows Vista, IPsecSaContextEnum0 is available.

Syntax


DWORD IPsecSaContextEnum1(
  _In_   HANDLE engineHandle,
  _In_   HANDLE enumHandle,
  _In_   UINT32 numEntriesRequested,
  _Out_  IPSEC_SA_CONTEXT1 ***entries,
  _Out_  UINT32 *numEntriesReturned
);

Parameters

engineHandle [in]

Type: HANDLE

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

enumHandle [in]

Type: HANDLE

Handle for an SA context enumeration returned by IPsecSaContextCreateEnumHandle0.

numEntriesRequested [in]

Type: UINT32

Number of SA contexts requested.

entries [out]

Type: IPSEC_SA_CONTEXT1***

Addresses of the enumeration entries.

numEntriesReturned [out]

Type: UINT32*

The number of SA contexts returned.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The IPsec SA contexts were enumerated 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 the numEntriesReturned is less than the numEntriesRequested, the enumeration is exhausted.

The returned array of entries (but not the individual entries themselves) must be freed by a call to FwpmFreeMemory0.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

IPSEC_SA_CONTEXT1
IPsecSaContextCreateEnumHandle0

 

 

Community Additions

ADD
Show:
© 2015 Microsoft