ホーム › NetworkManagement.IpHelper › GetIpErrorString

GetIpErrorString

関数

IP Helper APIのエラーコードを説明文字列に変換する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

DWORD GetIpErrorString(
    DWORD ErrorCode,
    LPWSTR Buffer,   // optional
    DWORD* Size
);

パラメーター

名前	型	方向	説明
ErrorCode	DWORD	in	取得対象のエラーコード。このパラメーターに指定できる値は、Ipexport.h ヘッダーファイルで定義されています。
Buffer	LPWSTR	outoptional	関数が NO_ERROR を返した場合に、エラーコード文字列が格納されるバッファーへのポインター。
Size	DWORD*	inout	Buffer パラメーターが指すバッファーの長さを文字数で指定する DWORD へのポインター。終端の null は含みません(すなわち、Buffer のサイズを文字数で表した値から 1 を引いた値)。

戻り値の型: DWORD

公式ドキュメント

GetIpErrorString 関数は、IP Helper のエラー文字列を取得します。

戻り値

成功した場合は NO_ERROR を返します。

関数が失敗した場合は、FormatMessage を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

解説(Remarks)

GetIpErrorString 関数は、IP エラーコードに対応する IP Helper のエラー文字列を取得するために使用できます。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 Software Development Kit (SDK) で若干変更されました。Buffer パラメーターのデータ型が PWCHAR から PWSTR に変更されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

DWORD GetIpErrorString(
    DWORD ErrorCode,
    LPWSTR Buffer,   // optional
    DWORD* Size
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpErrorString(
    uint ErrorCode,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer,   // LPWSTR optional, out
    ref uint Size   // DWORD* in/out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpErrorString(
    ErrorCode As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> Buffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef Size As UInteger   ' DWORD* in/out
) As UInteger
End Function

' ErrorCode : DWORD
' Buffer : LPWSTR optional, out
' Size : DWORD* in/out
Declare PtrSafe Function GetIpErrorString Lib "iphlpapi" ( _
    ByVal ErrorCode As Long, _
    ByVal Buffer As LongPtr, _
    ByRef Size As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetIpErrorString = ctypes.windll.iphlpapi.GetIpErrorString
GetIpErrorString.restype = wintypes.DWORD
GetIpErrorString.argtypes = [
    wintypes.DWORD,  # ErrorCode : DWORD
    wintypes.LPWSTR,  # Buffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # Size : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpErrorString = Fiddle::Function.new(
  lib['GetIpErrorString'],
  [
    -Fiddle::TYPE_INT,  # ErrorCode : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # Size : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetIpErrorString(
        ErrorCode: u32,  // DWORD
        Buffer: *mut u16,  // LPWSTR optional, out
        Size: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIpErrorString(uint ErrorCode, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer, ref uint Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIpErrorString' -Namespace Win32 -PassThru
# $api::GetIpErrorString(ErrorCode, Buffer, Size)

#uselib "IPHLPAPI.dll"
#func global GetIpErrorString "GetIpErrorString" sptr, sptr, sptr
; GetIpErrorString ErrorCode, varptr(Buffer), varptr(Size)   ; 戻り値は stat
; ErrorCode : DWORD -> "sptr"
; Buffer : LPWSTR optional, out -> "sptr"
; Size : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global GetIpErrorString "GetIpErrorString" int, var, var
; res = GetIpErrorString(ErrorCode, Buffer, Size)
; ErrorCode : DWORD -> "int"
; Buffer : LPWSTR optional, out -> "var"
; Size : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global GetIpErrorString "GetIpErrorString" int, sptr, sptr
; res = GetIpErrorString(ErrorCode, varptr(Buffer), varptr(Size))
; ErrorCode : DWORD -> "int"
; Buffer : LPWSTR optional, out -> "sptr"
; Size : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。