IPsecGetStatistics1 function (fwpmk.h)

  • Article

The IPsecGetStatistics1 function retrieves Internet Protocol Security (IPsec) statistics.

Syntax

NTSTATUS IPsecGetStatistics1(
  [in]  HANDLE            engineHandle,
  [out] IPSEC_STATISTICS1 *ipsecStatistics
);

Parameters

[in] engineHandle

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

[out] ipsecStatistics

Top-level object of IPsec statistics organization.

Return value

Return code/value Description
ERROR_SUCCESS
0		 The IPsec statistics were successfully retrieved.
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

This function cannot be called from within a transaction, it fails with FWP_E_TXN_IN_PROGRESS. See Object Management for more information about transactions.

The caller needs FWPM_ACTRL_READ_STATS access to the IPsec security associations database. See Access Control for more information.

IPsecGetStatistics1 is a specific implementation of IPsecGetStatistics. 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

See also