Edit

Share via

IPsecSaContextSubscriptionsGet0 function (fwpmu.h)

  • Article

The IPsecSaContextSubscriptionsGet0 function retrieves an array of all the current IPsec security association (SA) change notification subscriptions.

Syntax

DWORD IPsecSaContextSubscriptionsGet0(
  [in]  HANDLE                         engineHandle,
  [out] IPSEC_SA_CONTEXT_SUBSCRIPTION0 ***entries,
  [out] UINT32                         *numEntries
);

Parameters

[in] engineHandle

Type: HANDLE

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

[out] entries

Type: IPSEC_SA_CONTEXT_SUBSCRIPTION0***

The current IPsec SA notification subscriptions.

[out] numEntries

Type: UINT32*

The number of entries returned.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The subscriptions were retrieved 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

The returned array (but not the individual entries in the array) must be freed through a call to FwpmFreeMemory0.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

IPSEC_SA_CONTEXT_SUBSCRIPTION0