Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › ICMP_ECHO_REPLY

ICMP_ECHO_REPLY

構造体
サイズx64: 40 バイト / x86: 28 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
AddressDWORD4+0+0応答した IPv4 アドレスです。IPAddr 構造体の形式で格納されます。
StatusDWORD4+4+4

エコー要求の状態を IP_STATUS コードの形式で示します。このメンバーに指定できる値は、Ipexport.h ヘッダーファイルで定義されています。

意味
IP_SUCCESS
0
状態は成功です。
IP_BUF_TOO_SMALL
11001
応答バッファーが小さすぎました。
IP_DEST_NET_UNREACHABLE
11002
宛先ネットワークに到達できませんでした。
IP_DEST_HOST_UNREACHABLE
11003
宛先ホストに到達できませんでした。
IP_DEST_PROT_UNREACHABLE
11004
宛先プロトコルに到達できませんでした。
IP_DEST_PORT_UNREACHABLE
11005
宛先ポートに到達できませんでした。
IP_NO_RESOURCES
11006
利用できる IP リソースが不足していました。
IP_BAD_OPTION
11007
不正な IP オプションが指定されました。
IP_HW_ERROR
11008
ハードウェアエラーが発生しました。
IP_PACKET_TOO_BIG
11009
パケットが大きすぎました。
IP_REQ_TIMED_OUT
11010
要求がタイムアウトしました。
IP_BAD_REQ
11011
不正な要求です。
IP_BAD_ROUTE
11012
不正なルートです。
IP_TTL_EXPIRED_TRANSIT
11013
転送中に TTL (time to live) が期限切れになりました。
IP_TTL_EXPIRED_REASSEM
11014
フラグメントの再構成中に TTL が期限切れになりました。
IP_PARAM_PROBLEM
11015
パラメーターに問題があります。
IP_SOURCE_QUENCH
11016
データグラムの到着が速すぎて処理できず、データグラムが破棄された可能性があります。
IP_OPTION_TOO_BIG
11017
IP オプションが大きすぎました。
IP_BAD_DESTINATION
11018
不正な宛先です。
IP_GENERAL_FAILURE
11050
一般的なエラーです。このエラーは、形式が不正な ICMP パケットに対して返されることがあります。
RoundTripTimeDWORD4+8+8ラウンドトリップ時間 (ミリ秒単位) です。
DataSizeWORD2+12+12応答のデータサイズ (バイト単位) です。
ReservedWORD2+14+14システム用に予約済みです。
Datavoid*8/4+16+16応答データへのポインターです。
OptionsIP_OPTION_INFORMATION16/8+24+20応答の IP ヘッダーに含まれる IP オプションです。IP_OPTION_INFORMATION 構造体の形式で格納されます。

公式ドキュメント

ICMP_ECHO_REPLY 構造体は、IPv4 エコー要求に対する応答で返されるデータを記述します。

解説(Remarks)

ICMP_ECHO_REPLY 構造体は、IcmpParseReplies 関数が IPv4 エコー要求への応答を返すために使用します。64 ビットプラットフォームでは、ICMP_ECHO_REPLY32 構造体を使用してください。

IPv4 の場合、Status メンバーに指定できる値の一部は RFC 792 で規定されています。

Status メンバーの IP_STATUS エラーコードに対応する IP ヘルパーのエラー文字列を取得するには、GetIpErrorString 関数を使用できます。

ICMP_ECHO_REPLY 構造体は Ipexport.h ヘッダーファイルで定義されており、このファイルは Iphlpapi.h ヘッダーファイルに自動的にインクルードされます。Ipexport.h ヘッダーファイルを直接使用しないでください。

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

各言語での定義

#include <windows.h>

// IP_OPTION_INFORMATION  (x64 16 / x86 8 バイト)
typedef struct IP_OPTION_INFORMATION {
    BYTE Ttl;
    BYTE Tos;
    BYTE Flags;
    BYTE OptionsSize;
    BYTE* OptionsData;
} IP_OPTION_INFORMATION;

// ICMP_ECHO_REPLY  (x64 40 / x86 28 バイト)
typedef struct ICMP_ECHO_REPLY {
    DWORD Address;
    DWORD Status;
    DWORD RoundTripTime;
    WORD DataSize;
    WORD Reserved;
    void* Data;
    IP_OPTION_INFORMATION Options;
} ICMP_ECHO_REPLY;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IP_OPTION_INFORMATION
{
    public byte Ttl;
    public byte Tos;
    public byte Flags;
    public byte OptionsSize;
    public IntPtr OptionsData;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct ICMP_ECHO_REPLY
{
    public uint Address;
    public uint Status;
    public uint RoundTripTime;
    public ushort DataSize;
    public ushort Reserved;
    public IntPtr Data;
    public IP_OPTION_INFORMATION Options;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IP_OPTION_INFORMATION
    Public Ttl As Byte
    Public Tos As Byte
    Public Flags As Byte
    Public OptionsSize As Byte
    Public OptionsData As IntPtr
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure ICMP_ECHO_REPLY
    Public Address As UInteger
    Public Status As UInteger
    Public RoundTripTime As UInteger
    Public DataSize As UShort
    Public Reserved As UShort
    Public Data As IntPtr
    Public Options As IP_OPTION_INFORMATION
End Structure
import ctypes
from ctypes import wintypes

class IP_OPTION_INFORMATION(ctypes.Structure):
    _fields_ = [
        ("Ttl", ctypes.c_ubyte),
        ("Tos", ctypes.c_ubyte),
        ("Flags", ctypes.c_ubyte),
        ("OptionsSize", ctypes.c_ubyte),
        ("OptionsData", ctypes.c_void_p),
    ]

class ICMP_ECHO_REPLY(ctypes.Structure):
    _fields_ = [
        ("Address", wintypes.DWORD),
        ("Status", wintypes.DWORD),
        ("RoundTripTime", wintypes.DWORD),
        ("DataSize", ctypes.c_ushort),
        ("Reserved", ctypes.c_ushort),
        ("Data", ctypes.c_void_p),
        ("Options", IP_OPTION_INFORMATION),
    ]
#[repr(C)]
pub struct IP_OPTION_INFORMATION {
    pub Ttl: u8,
    pub Tos: u8,
    pub Flags: u8,
    pub OptionsSize: u8,
    pub OptionsData: *mut core::ffi::c_void,
}

#[repr(C)]
pub struct ICMP_ECHO_REPLY {
    pub Address: u32,
    pub Status: u32,
    pub RoundTripTime: u32,
    pub DataSize: u16,
    pub Reserved: u16,
    pub Data: *mut core::ffi::c_void,
    pub Options: IP_OPTION_INFORMATION,
}
import "golang.org/x/sys/windows"

type IP_OPTION_INFORMATION struct {
	Ttl byte
	Tos byte
	Flags byte
	OptionsSize byte
	OptionsData uintptr
}

type ICMP_ECHO_REPLY struct {
	Address uint32
	Status uint32
	RoundTripTime uint32
	DataSize uint16
	Reserved uint16
	Data uintptr
	Options IP_OPTION_INFORMATION
}
type
  IP_OPTION_INFORMATION = record
    Ttl: Byte;
    Tos: Byte;
    Flags: Byte;
    OptionsSize: Byte;
    OptionsData: Pointer;
  end;

  ICMP_ECHO_REPLY = record
    Address: DWORD;
    Status: DWORD;
    RoundTripTime: DWORD;
    DataSize: Word;
    Reserved: Word;
    Data: Pointer;
    Options: IP_OPTION_INFORMATION;
  end;
const IP_OPTION_INFORMATION = extern struct {
    Ttl: u8,
    Tos: u8,
    Flags: u8,
    OptionsSize: u8,
    OptionsData: ?*anyopaque,
};

const ICMP_ECHO_REPLY = extern struct {
    Address: u32,
    Status: u32,
    RoundTripTime: u32,
    DataSize: u16,
    Reserved: u16,
    Data: ?*anyopaque,
    Options: IP_OPTION_INFORMATION,
};
type
  IP_OPTION_INFORMATION {.bycopy.} = object
    Ttl: uint8
    Tos: uint8
    Flags: uint8
    OptionsSize: uint8
    OptionsData: pointer

  ICMP_ECHO_REPLY {.bycopy.} = object
    Address: uint32
    Status: uint32
    RoundTripTime: uint32
    DataSize: uint16
    Reserved: uint16
    Data: pointer
    Options: IP_OPTION_INFORMATION
struct IP_OPTION_INFORMATION
{
    ubyte Ttl;
    ubyte Tos;
    ubyte Flags;
    ubyte OptionsSize;
    void* OptionsData;
}

struct ICMP_ECHO_REPLY
{
    uint Address;
    uint Status;
    uint RoundTripTime;
    ushort DataSize;
    ushort Reserved;
    void* Data;
    IP_OPTION_INFORMATION Options;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; ICMP_ECHO_REPLY サイズ: 28 バイト(x86)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; Address : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Status : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; RoundTripTime : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; DataSize : WORD (+12, 2byte)  wpoke st,12,値  /  値 = wpeek(st,12)
; Reserved : WORD (+14, 2byte)  wpoke st,14,値  /  値 = wpeek(st,14)
; Data : void* (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; Options : IP_OPTION_INFORMATION (+20, 8byte)  varptr(st)+20 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; ICMP_ECHO_REPLY サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; Address : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Status : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; RoundTripTime : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; DataSize : WORD (+12, 2byte)  wpoke st,12,値  /  値 = wpeek(st,12)
; Reserved : WORD (+14, 2byte)  wpoke st,14,値  /  値 = wpeek(st,14)
; Data : void* (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; Options : IP_OPTION_INFORMATION (+24, 16byte)  varptr(st)+24 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global IP_OPTION_INFORMATION
    #field byte Ttl
    #field byte Tos
    #field byte Flags
    #field byte OptionsSize
    #field intptr OptionsData
#endstruct

#defstruct global ICMP_ECHO_REPLY
    #field int Address
    #field int Status
    #field int RoundTripTime
    #field short DataSize
    #field short Reserved
    #field intptr Data
    #field IP_OPTION_INFORMATION Options
#endstruct

stdim st, ICMP_ECHO_REPLY        ; NSTRUCT 変数を確保
st->Address = 100
mes "Address=" + st->Address