FwpmvSwitchEventSubscribe0 function (fwpmu.h)

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

Syntax

DWORD FwpmvSwitchEventSubscribe0(
  [in]           HANDLE                                 engineHandle,
  [in]           const FWPM_VSWITCH_EVENT_SUBSCRIPTION0 *subscription,
  [in]           FWPM_VSWITCH_EVENT_CALLBACK0           callback,
  [in, optional] void                                   *context,
  [out]          HANDLE                                 *subscriptionHandle
);

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 FWPM_VSWITCH_EVENT_SUBSCRIPTION0*

The notifications which will be delivered.

[in] callback

Type: FWPM_VSWITCH_EVENT_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] subscriptionHandle

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 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

See also

FwpmvSwitchEventUnsubscribe0

WFP Functions