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 (，亦即，以字元為單位的 Buffer 大小減一) 。

成功時傳回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。

GetIpErrorString函式的語法在 Microsoft Windows 軟體發展工具組 (SDK 上稍有變更，) 針對 Windows Vista 和更新版本發行。 Buffer參數的資料類型已從PWCHAR變更為PWSTR。