Edit

FwpmConnectionGetById0 function (fwpmu.h)

  • Article

The FwpmConnectionGetById0 function retrieves a connection object.

Syntax

DWORD FwpmConnectionGetById0(
  [in]  HANDLE           engineHandle,
  [in]  UINT64           id,
  [out] FWPM_CONNECTION0 **connection
);

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

Type: UINT64

The run-time identifier for the connection.

[out] connection

Type: FWPM_CONNECTION0**

The connection information.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The connection object was 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 caller must free the returned object by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the provider context. See Access Control for more information.

Requirements

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

See also

FWPM_CONNECTION0