IPsecGetStatistics0 function

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

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

Syntax


DWORD WINAPI IPsecGetStatistics0(
  _In_   HANDLE engineHandle,
  _Out_  IPSEC_STATISTICS0 *ipsecStatistics
);

Parameters

engineHandle [in]

Type: HANDLE

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

ipsecStatistics [out]

Type: IPSEC_STATISTICS0*

Top-level object of IPsec statistics organization.

Return value

Type: DWORD

Return code/valueDescription
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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

IPSEC_STATISTICS0

 

 

Community Additions

ADD
Show:
© 2014 Microsoft