IPsecGetStatistics1 function (fwpmu.h)

  • Article

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

Note  IPsecGetStatistics1 is the specific implementation of IPsecGetStatistics used in Windows 7 and later. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows Vista, IPsecGetStatistics0 is available.
 

Syntax

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

Parameters

[in] engineHandle

Type: HANDLE

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

[out] ipsecStatistics

Type: IPSEC_STATISTICS1*

Top-level object of IPsec statistics organization.

Return value

Type: DWORD

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.

Remarks

This function cannot be called from within a transaction. It will fail 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.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

IPSEC_STATISTICS1