Skip to content

Latest commit

 

History

History
136 lines (107 loc) · 3.54 KB

nf-fwpmu-fwpmcalloutgetbykey0.md

File metadata and controls

136 lines (107 loc) · 3.54 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fwpmu.FwpmCalloutGetByKey0
FwpmCalloutGetByKey0 function (fwpmu.h)
Retrieves a callout object. (FwpmCalloutGetByKey0)
FwpmCalloutGetByKey0
FwpmCalloutGetByKey0 function [Filtering]
fwp.fwpmcalloutgetbykey0_func
fwpmu/FwpmCalloutGetByKey0
fwp\fwpmcalloutgetbykey0_func.htm
fwp
05c5ac43-adf1-419c-8a39-32f8dddd3b98
12/05/2018
FwpmCalloutGetByKey0, FwpmCalloutGetByKey0 function [Filtering], fwp.fwpmcalloutgetbykey0_func, fwpmu/FwpmCalloutGetByKey0
fwpmu.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Fwpuclnt.lib
Fwpuclnt.dll
Windows
19H1
FwpmCalloutGetByKey0
fwpmu/FwpmCalloutGetByKey0
c++
APIRef
kbSyntax
DllExport
Fwpuclnt.dll
FwpmCalloutGetByKey0

FwpmCalloutGetByKey0 function

-description

The FwpmCalloutGetByKey0 function retrieves a callout object.

-parameters

-param engineHandle [in]

Type: HANDLE

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

-param key [in]

Type: const GUID*

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.

-param callout [out]

Type: FWPM_CALLOUT0**

Information about the state associated with the callout.

-returns

Type: DWORD

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.

-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.

-see-also

FWPM_CALLOUT0

FwpmCalloutAdd0