FwpmvSwitchEventSubscribe0 function

The FwpmvSwitchEventSubscribe0 function is used to request the delivery of notifications regarding a particular vSwitch event.

Syntax


DWORD WINAPI FwpmvSwitchEventSubscribe0(
  _In_      HANDLE engineHandle,
  _In_      const FWPM_VSWITCH_EVENT_SUBSCRIPTION0 *subscription,
  _In_      FWPM_VSWITCH_EVENT_CALLBACK0 callback,
  _In_opt_  void *context,
  _Out_     HANDLE *subscriptionHandle
);

Parameters

engineHandle [in]

Type: HANDLE

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

subscription [in]

Type: const FWPM_VSWITCH_EVENT_SUBSCRIPTION0*

The notifications which will be delivered.

callback [in]

Type: FWPM_VSWITCH_EVENT_CALLBACK0

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

context [in, optional]

Type: void*

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

subscriptionHandle [out]

Type: HANDLE*

Handle to the newly created subscription.

Return value

Type: DWORD

Return code/valueDescription
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 virtual switch event's container.

FwpmvSwitchEventSubscribe0 is a specific implementation of FwpmvSwitchEventSubscribe. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

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

See also

WFP Functions
FwpmvSwitchEventUnsubscribe0

 

 

Community Additions

ADD
Show:
© 2014 Microsoft