getIpErrorString 函数 (iphlpapi.h)

GetIpErrorString 函数检索 IP 帮助程序错误字符串。

语法

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

[in] ErrorCode

要检索的错误代码。此参数的可能值在 Ipexport.h 头文件中定义。

[out] Buffer

指向包含错误代码字符串的缓冲区的指针，如果函数返回并NO_ERROR。

[in, out] Size

指向 DWORD 的指针，该指针指定 Buffer 参数指向的缓冲区的长度（以字符为单位），不包括终止 null (即缓冲区的大小（以字符为单位），减去一) 。

成功后返回NO_ERROR。

如果函数失败，请使用 FormatMessage 获取返回错误的消息字符串。

GetIpErrorString 函数可用于检索 IP 错误代码的 IP 帮助程序错误字符串。在 ErrorCode 参数中传递的IP_STATUS错误代码在 ICMP 和 ICMPv6 函数使用的ICMP_ECHO_REPLY、ICMP_ECHO_REPLY32和ICMPV6_ECHO_REPLY结构的状态成员中返回。使用这些结构的函数包括 Icmp6ParseReplies、 Icmp6SendEcho2、 IcmpParseReplies、 IcmpSendEcho、 IcmpSendEcho2 和 IcmpSendEcho2Ex。

在 Windows Vista 及更高版本发布的 Microsoft Windows 软件开发工具包 (SDK) 上， GetIpErrorString 函数的语法略有更改。 Buffer 参数的数据类型已从 PWCHAR 更改为 PWSTR。