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
Buffer パラメーターが指すバッファーの長さを指定する DWORD へのポインター。終端の null (つまり、Buffer のサイズ (文字数) から 1 を引いた値を除きます)。
戻り値
成功時にNO_ERRORを返します。
関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。
解説
GetIpErrorString 関数を使用して、IP エラー コードの IP ヘルパー エラー文字列を取得できます。 ErrorCode パラメーターで渡されたIP_STATUSエラー コードは、ICMP および ICMPv6 関数で使用されるICMP_ECHO_REPLY、ICMP_ECHO_REPLY32、およびICMPV6_ECHO_REPLY構造体の Status メンバーで返されます。 これらの構造体を使用する関数には、 Icmp6ParseReplies、 Icmp6SendEcho2、 IcmpParseReplies、 IcmpSendEcho、 IcmpSendEcho2、 および IcmpSendEcho2Ex が含まれます。
GetIpErrorString 関数の構文は、Windows Vista 以降用にリリースされた Microsoft Windows ソフトウェア開発キット (SDK) で若干変更されました。 Buffer パラメーターのデータ型が PWCHAR から PWSTR に変更されました。
要件
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | iphlpapi.h |
| Library | Iphlpapi.lib |
| [DLL] | Iphlpapi.dll |