Edit

Share via

FwpmSystemPortsGet0 function (fwpmu.h)

  • Article

The FwpmSystemPortsGet0 function retrieves an array of all of the system port types.

Syntax

DWORD FwpmSystemPortsGet0(
  [in, optional] HANDLE             engineHandle,
  [out]          FWPM_SYSTEM_PORTS0 **sysPorts
);

Parameters

[in, optional] engineHandle

Type: HANDLE

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

[out] sysPorts

Type: FWPM_SYSTEM_PORTS0**

The array of system port types.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The subscriptions were retrieved 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

The returned array (but not the individual entries in the array) must be freed through a call to FwpmFreeMemory0.

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

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

FWPM_SYSTEM_PORTS0