IkeextSaEnum0 function (fwpmk.h)
The IkeextSaEnum0 function returns the next page of results from the IKE/AuthIP security association (SA) enumerator.
Syntax
NTSTATUS IkeextSaEnum0(
[in] HANDLE engineHandle,
[in] HANDLE enumHandle,
[in] UINT32 numEntriesRequested,
[out] IKEEXT_SA_DETAILS0 ***entries,
[out] UINT32 *numEntriesReturned
);
Parameters
[in] engineHandle
Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
[in] enumHandle
Handle for an IKE/AuthIP SA enumeration. Call IkeextSaCreateEnumHandle0 to obtain an enumeration handle.
[in] numEntriesRequested
Number of enumeration entries requested.
[out] entries
Addresses of the enumeration entries.
[out] numEntriesReturned
The number of enumeration entries returned.
Return value
| Return code/value | Description |
|---|---|
| ERROR_SUCCESS 0 |
The SAs were enumerated 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
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.
IkeextSaEnum0 works on a snapshot of the SAs taken at the time the enumeration handle was created.
IkeextSaEnum0 is a specific implementation of IkeextSaEnum. 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 |