FwpmSystemPortsSubscribe0 function

The FwpmSystemPortsSubscribe0 function is used to request the delivery of notifications regarding a particular system port.

Syntax


DWORD WINAPI FwpmSystemPortsSubscribe0(
  _In_opt_   HANDLE                      engineHandle,
  _Reserved_ void                        *reserved,
  _In_       FWPM_SYSTEM_PORTS_CALLBACK0 callback,
  _In_opt_   void                        *context,
  _Out_      HANDLE                      *sysPortsHandle
);

Parameters

engineHandle [in, optional]

Type: HANDLE

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

reserved

Type: void*

Reserved.

callback [in]

Type: FWPM_SYSTEM_PORTS_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 system port.

sysPortsHandle [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.

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

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FwpmSystemPortsUnsubscribe0
FWPM_SYSTEM_PORTS_CALLBACK0

 

 

Show: