FwpmConnectionSubscribe0 function (fwpmu.h)

The FwpmConnectionSubscribe0 function is used to request the delivery of notifications about changes to a connection object.

Syntax

DWORD FwpmConnectionSubscribe0(
  [in]           HANDLE                              engineHandle,
  [in]           const FWPM_CONNECTION_SUBSCRIPTION0 *subscription,
  [in]           FWPM_CONNECTION_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: FWPM_CONNECTION_SUBSCRIPTION0*

The notifications which will be delivered.

[in] callback

Type: FWPM_CONNECTION_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

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 connection object's container.

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

FWPM_CONNECTION_CALLBACK0

FWPM_CONNECTION_SUBSCRIPTION0

FwpmConnectionUnsubscribe0