FwpmCalloutGetById0 function (fwpmk.h)

  • Article

The FwpmCalloutGetById0 function retrieves a callout from the filter engine by using the run-time identifier for the callout.

Syntax

NTSTATUS FwpmCalloutGetById0(
  [in]  HANDLE        engineHandle,
  [in]  UINT32        id,
  [out] FWPM_CALLOUT0 **callout
);

Parameters

[in] engineHandle

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

[in] id

The run-time identifier for the callout to retrieve from the filter engine. This must be the run-time identifier that was returned when the callout driver called the FwpmCalloutAdd0 function to add the callout to the filter engine.

[out] callout

Information about the state associated with the callout specified by the id parameter.

Return value

The FwpmCalloutGetById0 function returns one of the following NTSTATUS codes.

Return code/value Description
ERROR_SUCCESS
0		 The callout 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 callout. See Access Control for more information.

FwpmCalloutGetById0 is a specific implementation of FwpmCalloutGetById. See WFP Version-Independent Names and Targeting Specific Versions of Windows 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