FwpmConnectionUnsubscribe0 function (fwpmu.h)

  • Article

The FwpmConnectionUnsubscribe0 function is used to cancel a connection object change event subscription and stop receiving notifications.

Syntax

DWORD FwpmConnectionUnsubscribe0(
  [in]      HANDLE engineHandle,
  [in, 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, out] eventsHandle

Type: HANDLE

Handle of the subscribed event notification. This is the returned handle from the call to FwpmConnectionSubscribe0.

This may be NULL, in which case the function will have no effect.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The subscription was deleted 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 callback is currently being invoked, this function will not return until it completes. Thus, when calling this function, you must not hold any locks that the callback may also try to acquire lest you deadlock.

It is not necessary to unsubscribe before closing a session; all subscriptions are automatically canceled when the subscribing session terminates.

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.

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

FwpmConnectionSubscribe0