Edit

Share via

FwpmConnectionGetById0 function (fwpmk.h)

  • Article

The FwpmConnectionGetById0 function retrieves a connection object by using the run-time identifier for the connection.

Syntax

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

Parameters

[in] engineHandle

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

[in] id

The run-time identifier for the connection.

[out] connection

The connection information.

Return value

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.
Other NTSTATUS codes An error occurred.

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 Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also