Función GetIpErrorString (iphlpapi.h)

Artículo
08/24/2023

La función GetIpErrorString recupera una cadena de error del asistente de IP.

Sintaxis

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

Parámetros

[in] ErrorCode

Código de error que se va a recuperar. Los valores posibles para este parámetro se definen en el archivo de encabezado Ipexport.h .

[out] Buffer

Puntero al búfer que contiene la cadena de código de error si la función devuelve con NO_ERROR.

[in, out] Size

Puntero a un DWORD que especifica la longitud, en caracteres, del búfer al que apunta el parámetro Buffer , excluyendo el valor NULL de terminación (es decir, el tamaño de Buffer en caracteres, menos uno).

Valor devuelto

Devuelve NO_ERROR si se realiza correctamente.

Si se produce un error en la función, use FormatMessage para obtener la cadena de mensaje para el error devuelto.

Comentarios

La función GetIpErrorString se puede usar para recuperar una cadena de error del asistente de IP para un código de error de IP. El código de error IP_STATUS pasado en el parámetro ErrorCode se devuelve en el miembro Status del ICMP_ECHO_REPLY, ICMP_ECHO_REPLY32 y estructuras de ICMPV6_ECHO_REPLY usadas por las funciones ICMP e ICMPv6. Las funciones que usan estas estructuras incluyen Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2 e IcmpSendEcho2Ex.

La sintaxis de la función GetIpErrorString se cambió ligeramente en el Kit de desarrollo de software (SDK) de Microsoft Windows publicado para Windows Vista y versiones posteriores. El tipo de datos del parámetro Buffer se cambió de PWCHAR a PWSTR.

Requisitos


Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	iphlpapi.h
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll