IPsecSaContextUnsubscribe0 function

The IPsecSaContextUnsubscribe0 function is used to cancel an IPsec security association (SA) change subscription and stop receiving change notifications.

Syntax


DWORD WINAPI IPsecSaContextUnsubscribe0(
  _In_     HANDLE engineHandle,
  _Inout_  HANDLE eventsHandle
);

Parameters

engineHandle [in]

Type: HANDLE

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

eventsHandle [in, out]

Type: HANDLE

Handle of the subscribed SA change notification. This is the returned handle from the call to IPsecSaContextSubscribe0.

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

Return value

Type: DWORD

Return code/valueDescription
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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft