FwpmCalloutGetById0 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS FwpmCalloutGetById0(
[in] HANDLE engineHandle,
[in] UINT32 id,
[out] FWPM_CALLOUT0 **callout
);
View the official Windows Driver Kit DDI referenceNo description available.
The FwpmCalloutGetById0 function retrieves a callout from the filter engine by using the run-time identifier for the callout.
engineHandle [in]A handle for an open session to the filter engine. Call FwpmEngineOpen0 function to open a session to the filter engine.
id [in]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.
callout [out]Information about the state associated with the callout specified by the id parameter.
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. |
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.