Função GetIcmpStatisticsEx (iphlpapi.h)

Artigo
02/28/2024

A função GetIcmpStatisticsEx recupera estatísticas do protocolo ICMP para o computador local. A função GetIcmpStatisticsEx é capaz de recuperar estatísticas de ICMP IPv6.

Sintaxe

IPHLPAPI_DLL_LINKAGE ULONG GetIcmpStatisticsEx(
  [out] PMIB_ICMP_EX Statistics,
  [in]  ULONG        Family
);

Parâmetros

[out] Statistics

Um ponteiro para uma estrutura MIB_ICMP_EX que contém estatísticas ICMP para o computador local.

[in] Family

A família de protocolos para a qual recuperar estatísticas ICMP. Deve ser uma destas opções:

Valor	Significado
AF_INET	Protocolo internet versão 4 (IPv4).
AF_INET6	IPv6 (protocolo IP versão 6).

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos códigos de erro a seguir.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	O parâmetro pStats é NULL ou não aponta para memória válida ou o parâmetro dwFamily não é um valor válido.
ERROR_NOT_SUPPORTED	Não há suporte para essa função no sistema operacional no qual a chamada de função foi feita.
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

O GetIpStatisticsEx pode ser usado para obter as estatísticas de ICMP para IPv4 ou IPv6 no computador local.

A função GetIcmpStatistics retorna as estatísticas de ICMP somente para IPv4 no computador local.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho \| aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	iphlpapi.h
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll