FwpmCalloutGetByKey0 function (fwpmk.h)

  • Article

The FwpmCalloutGetByKey0 function retrieves a callout by using the GUID key for the callout.

Syntax

NTSTATUS FwpmCalloutGetByKey0(
  [in]  HANDLE        engineHandle,
  [in]  const GUID    *key,
  [out] FWPM_CALLOUT0 **callout
);

Parameters

[in] engineHandle

A handle for an open session to the filter engine. A callout driver calls the FwpmEngineOpen0 function to open a session to the filter engine.

[in] key

Unique identifier of the callout. This GUID was specified in the calloutKey member of the callout parameter when the application called FwpmCalloutAdd0 for this object.

[out] callout

Information about the state associated with the callout.

Return value

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.

FwpmCalloutGetByKey0 is a specific implementation of FwpmCalloutGetByKey. 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