IPsecSaContextSubscribe0 function (fwpmu.h)

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

Syntax

DWORD IPsecSaContextSubscribe0(
  [in]           HANDLE                               engineHandle,
  [in]           const IPSEC_SA_CONTEXT_SUBSCRIPTION0 *subscription,
  [in]           IPSEC_SA_CONTEXT_CALLBACK0           callback,
  [in, optional] void                                 *context,
  [out]          HANDLE                               *eventsHandle
);

Parameters

[in] engineHandle

Type: HANDLE

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

[in] subscription

Type: const IPSEC_SA_CONTEXT_SUBSCRIPTION0*

The notifications which will be delivered.

[in] callback

Type: IPSEC_SA_CONTEXT_CALLBACK0

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

[in, optional] context

Type: void*

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

[out] eventsHandle

Type: HANDLE*

Handle to the newly created subscription.

Return value

Type: DWORD

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

See also

IPSEC_SA_CONTEXT_CALLBACK0

IPSEC_SA_CONTEXT_SUBSCRIPTION0