FwpmCalloutEnum0 function (fwpmu.h)
The FwpmCalloutEnum0 function returns the next page of results from the callout enumerator.
Syntax
DWORD FwpmCalloutEnum0(
[in] HANDLE engineHandle,
[in] HANDLE enumHandle,
[in] UINT32 numEntriesRequested,
[out] FWPM_CALLOUT0 ***entries,
[out] UINT32 *numEntriesReturned
);
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] enumHandle
Type: HANDLE
Handle for a callout enumeration created by a call to FwpmCalloutCreateEnumHandle0.
[in] numEntriesRequested
Type: UINT32
The number of callout objects requested.
[out] entries
Type: FWP_CALLOUT0***
Addresses of the enumeration entries.
[out] numEntriesReturned
Type: UINT32*
The number of callouts returned.
Return value
Type: DWORD
| Return code/value | Description |
|---|---|
|
The callouts were enumerated 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
If the numEntriesReturned is less than the numEntriesRequested, the enumeration is exhausted.
The returned array of entries (but not the individual entries themselves) must be freed by a call to FwpmFreeMemory0.
A subsequent call using the same enumeration handle will return the next set of items following those in the last output buffer.
FwpmCalloutEnum0 works on a snapshot of the callouts taken at the time the enumeration handle was created.
FwpmCalloutEnum0 is a specific implementation of FwpmCalloutEnum. 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 |