Função GetIpErrorString (iphlpapi.h)

Artigo
08/24/2023

A função GetIpErrorString recupera uma cadeia de caracteres de erro do Auxiliar de IP.

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD GetIpErrorString(
  [in]      IP_STATUS ErrorCode,
  [out]     PWSTR     Buffer,
  [in, out] PDWORD    Size
);

Parâmetros

[in] ErrorCode

O código de erro a ser recuperado. Os valores possíveis para esse parâmetro são definidos no arquivo de cabeçalho Ipexport.h .

[out] Buffer

Um ponteiro para o buffer que contém a cadeia de caracteres de código de erro se a função retornar com NO_ERROR.

[in, out] Size

Um ponteiro para um DWORD que especifica o comprimento, em caracteres, do buffer apontado pelo parâmetro Buffer , excluindo o nulo de terminação (ou seja, o tamanho do Buffer em caracteres, menos um).

Valor retornado

Retorna NO_ERROR após o êxito.

Se a função falhar, use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetIpErrorString pode ser usada para recuperar uma cadeia de caracteres de erro do Auxiliar de IP para um código de erro de IP. O código de erro IP_STATUS passado no parâmetro ErrorCode é retornado no membro Status das estruturas ICMP_ECHO_REPLY, ICMP_ECHO_REPLY32 e ICMPV6_ECHO_REPLY usadas pelas funções ICMP e ICMPv6. As funções que usam essas estruturas incluem Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2 e IcmpSendEcho2Ex.

A sintaxe da função GetIpErrorString foi ligeiramente alterada no Microsoft Windows Software Development Kit (SDK) lançado para Windows Vista e posterior. O tipo de dados para o parâmetro Buffer foi alterado de PWCHAR para PWSTR.

Requisitos


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