FwpmCalloutGetByKey0 function (fwpmu.h)
The FwpmCalloutGetByKey0 function retrieves a callout object.
Syntax
DWORD FwpmCalloutGetByKey0(
[in] HANDLE engineHandle,
[in] const GUID *key,
[out] FWPM_CALLOUT0 **callout
);
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] key
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.
[out] callout
Type: FWPM_CALLOUT0**
Information about the state associated with the callout.
Return value
Type: DWORD
| Return code/value | Description |
|---|---|
|
The callout was retrieved successfully. |
|
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details. |
|
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.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | fwpmu.h |
| Library | Fwpuclnt.lib |
| DLL | Fwpuclnt.dll |