IPsecSaContextSubscribe0 function

The IPsecSaContextSubscribe0 function is used to request the delivery of notifications regarding a particular IPsec security association (SA) context.

Syntax

DWORD IPsecSaContextSubscribe0(
  HANDLE                               engineHandle,
  const IPSEC_SA_CONTEXT_SUBSCRIPTION0 *subscription,
  IPSEC_SA_CONTEXT_CALLBACK0           callback,
  void                                 *context,
  HANDLE                               *eventsHandle
);

Parameters

engineHandle

Type: HANDLE

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

subscription

Type: const IPSEC_SA_CONTEXT_SUBSCRIPTION0*

The notifications which will be delivered.

callback

Type: IPSEC_SA_CONTEXT_CALLBACK0

Function pointer that will be invoked when a notification is ready for delivery.

context

Type: void*

Optional context pointer. This pointer is passed to the callback function along with details of the event.

eventsHandle

Type: HANDLE*

Handle to the newly created subscription.

Return Value

Type: DWORD

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

This function cannot be called from within a transaction. It will fail with FWP_E_TXN_IN_PROGRESS. See Object Management for more information about transactions.

The caller needs FWPM_ACTRL_SUBSCRIBE access to the IPsec SA context's container.

Requirements

   
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_CALLBACK0

IPSEC_SA_CONTEXT_SUBSCRIPTION0