ホーム › NetworkManagement.IpHelper › Icmp6SendEcho2

Icmp6SendEcho2

関数

IPv6でICMPv6エコー要求を送信し応答を受信する。

DLLIPHLPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD Icmp6SendEcho2(
    HANDLE IcmpHandle,
    HANDLE Event,   // optional
    PIO_APC_ROUTINE ApcRoutine,   // optional
    void* ApcContext,   // optional
    SOCKADDR_IN6* SourceAddress,
    SOCKADDR_IN6* DestinationAddress,
    void* RequestData,
    WORD RequestSize,
    IP_OPTION_INFORMATION* RequestOptions,   // optional
    void* ReplyBuffer,
    DWORD ReplySize,
    DWORD Timeout
);

パラメーター

名前	型	方向
IcmpHandle	HANDLE	in
Event	HANDLE	inoptional
ApcRoutine	PIO_APC_ROUTINE	inoptional
ApcContext	void*	inoptional
SourceAddress	SOCKADDR_IN6*	in
DestinationAddress	SOCKADDR_IN6*	in
RequestData	void*	in
RequestSize	WORD	in
RequestOptions	IP_OPTION_INFORMATION*	inoptional
ReplyBuffer	void*	out
ReplySize	DWORD	in
Timeout	DWORD	in

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD Icmp6SendEcho2(
    HANDLE IcmpHandle,
    HANDLE Event,   // optional
    PIO_APC_ROUTINE ApcRoutine,   // optional
    void* ApcContext,   // optional
    SOCKADDR_IN6* SourceAddress,
    SOCKADDR_IN6* DestinationAddress,
    void* RequestData,
    WORD RequestSize,
    IP_OPTION_INFORMATION* RequestOptions,   // optional
    void* ReplyBuffer,
    DWORD ReplySize,
    DWORD Timeout
);

[DllImport("IPHLPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern uint Icmp6SendEcho2(
    IntPtr IcmpHandle,   // HANDLE
    IntPtr Event,   // HANDLE optional
    IntPtr ApcRoutine,   // PIO_APC_ROUTINE optional
    IntPtr ApcContext,   // void* optional
    IntPtr SourceAddress,   // SOCKADDR_IN6*
    IntPtr DestinationAddress,   // SOCKADDR_IN6*
    IntPtr RequestData,   // void*
    ushort RequestSize,   // WORD
    IntPtr RequestOptions,   // IP_OPTION_INFORMATION* optional
    IntPtr ReplyBuffer,   // void* out
    uint ReplySize,   // DWORD
    uint Timeout   // DWORD
);

<DllImport("IPHLPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function Icmp6SendEcho2(
    IcmpHandle As IntPtr,   ' HANDLE
    [Event] As IntPtr,   ' HANDLE optional
    ApcRoutine As IntPtr,   ' PIO_APC_ROUTINE optional
    ApcContext As IntPtr,   ' void* optional
    SourceAddress As IntPtr,   ' SOCKADDR_IN6*
    DestinationAddress As IntPtr,   ' SOCKADDR_IN6*
    RequestData As IntPtr,   ' void*
    RequestSize As UShort,   ' WORD
    RequestOptions As IntPtr,   ' IP_OPTION_INFORMATION* optional
    ReplyBuffer As IntPtr,   ' void* out
    ReplySize As UInteger,   ' DWORD
    Timeout As UInteger   ' DWORD
) As UInteger
End Function

' IcmpHandle : HANDLE
' Event : HANDLE optional
' ApcRoutine : PIO_APC_ROUTINE optional
' ApcContext : void* optional
' SourceAddress : SOCKADDR_IN6*
' DestinationAddress : SOCKADDR_IN6*
' RequestData : void*
' RequestSize : WORD
' RequestOptions : IP_OPTION_INFORMATION* optional
' ReplyBuffer : void* out
' ReplySize : DWORD
' Timeout : DWORD
Declare PtrSafe Function Icmp6SendEcho2 Lib "iphlpapi" ( _
    ByVal IcmpHandle As LongPtr, _
    ByVal Event As LongPtr, _
    ByVal ApcRoutine As LongPtr, _
    ByVal ApcContext As LongPtr, _
    ByVal SourceAddress As LongPtr, _
    ByVal DestinationAddress As LongPtr, _
    ByVal RequestData As LongPtr, _
    ByVal RequestSize As Integer, _
    ByVal RequestOptions As LongPtr, _
    ByVal ReplyBuffer As LongPtr, _
    ByVal ReplySize As Long, _
    ByVal Timeout As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

Icmp6SendEcho2 = ctypes.windll.iphlpapi.Icmp6SendEcho2
Icmp6SendEcho2.restype = wintypes.DWORD
Icmp6SendEcho2.argtypes = [
    wintypes.HANDLE,  # IcmpHandle : HANDLE
    wintypes.HANDLE,  # Event : HANDLE optional
    ctypes.c_void_p,  # ApcRoutine : PIO_APC_ROUTINE optional
    ctypes.POINTER(None),  # ApcContext : void* optional
    ctypes.c_void_p,  # SourceAddress : SOCKADDR_IN6*
    ctypes.c_void_p,  # DestinationAddress : SOCKADDR_IN6*
    ctypes.POINTER(None),  # RequestData : void*
    ctypes.c_ushort,  # RequestSize : WORD
    ctypes.c_void_p,  # RequestOptions : IP_OPTION_INFORMATION* optional
    ctypes.POINTER(None),  # ReplyBuffer : void* out
    wintypes.DWORD,  # ReplySize : DWORD
    wintypes.DWORD,  # Timeout : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
Icmp6SendEcho2 = Fiddle::Function.new(
  lib['Icmp6SendEcho2'],
  [
    Fiddle::TYPE_VOIDP,  # IcmpHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # Event : HANDLE optional
    Fiddle::TYPE_VOIDP,  # ApcRoutine : PIO_APC_ROUTINE optional
    Fiddle::TYPE_VOIDP,  # ApcContext : void* optional
    Fiddle::TYPE_VOIDP,  # SourceAddress : SOCKADDR_IN6*
    Fiddle::TYPE_VOIDP,  # DestinationAddress : SOCKADDR_IN6*
    Fiddle::TYPE_VOIDP,  # RequestData : void*
    -Fiddle::TYPE_SHORT,  # RequestSize : WORD
    Fiddle::TYPE_VOIDP,  # RequestOptions : IP_OPTION_INFORMATION* optional
    Fiddle::TYPE_VOIDP,  # ReplyBuffer : void* out
    -Fiddle::TYPE_INT,  # ReplySize : DWORD
    -Fiddle::TYPE_INT,  # Timeout : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn Icmp6SendEcho2(
        IcmpHandle: *mut core::ffi::c_void,  // HANDLE
        Event: *mut core::ffi::c_void,  // HANDLE optional
        ApcRoutine: *const core::ffi::c_void,  // PIO_APC_ROUTINE optional
        ApcContext: *mut (),  // void* optional
        SourceAddress: *mut SOCKADDR_IN6,  // SOCKADDR_IN6*
        DestinationAddress: *mut SOCKADDR_IN6,  // SOCKADDR_IN6*
        RequestData: *mut (),  // void*
        RequestSize: u16,  // WORD
        RequestOptions: *mut IP_OPTION_INFORMATION,  // IP_OPTION_INFORMATION* optional
        ReplyBuffer: *mut (),  // void* out
        ReplySize: u32,  // DWORD
        Timeout: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll", SetLastError = true)]
public static extern uint Icmp6SendEcho2(IntPtr IcmpHandle, IntPtr Event, IntPtr ApcRoutine, IntPtr ApcContext, IntPtr SourceAddress, IntPtr DestinationAddress, IntPtr RequestData, ushort RequestSize, IntPtr RequestOptions, IntPtr ReplyBuffer, uint ReplySize, uint Timeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_Icmp6SendEcho2' -Namespace Win32 -PassThru
# $api::Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, SourceAddress, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)

#uselib "IPHLPAPI.dll"
#func global Icmp6SendEcho2 "Icmp6SendEcho2" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; Icmp6SendEcho2 IcmpHandle, Event, ApcRoutine, ApcContext, varptr(SourceAddress), varptr(DestinationAddress), RequestData, RequestSize, varptr(RequestOptions), ReplyBuffer, ReplySize, Timeout   ; 戻り値は stat
; IcmpHandle : HANDLE -> "sptr"
; Event : HANDLE optional -> "sptr"
; ApcRoutine : PIO_APC_ROUTINE optional -> "sptr"
; ApcContext : void* optional -> "sptr"
; SourceAddress : SOCKADDR_IN6* -> "sptr"
; DestinationAddress : SOCKADDR_IN6* -> "sptr"
; RequestData : void* -> "sptr"
; RequestSize : WORD -> "sptr"
; RequestOptions : IP_OPTION_INFORMATION* optional -> "sptr"
; ReplyBuffer : void* out -> "sptr"
; ReplySize : DWORD -> "sptr"
; Timeout : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global Icmp6SendEcho2 "Icmp6SendEcho2" sptr, sptr, sptr, sptr, var, var, sptr, int, var, sptr, int, int
; res = Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, SourceAddress, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
; IcmpHandle : HANDLE -> "sptr"
; Event : HANDLE optional -> "sptr"
; ApcRoutine : PIO_APC_ROUTINE optional -> "sptr"
; ApcContext : void* optional -> "sptr"
; SourceAddress : SOCKADDR_IN6* -> "var"
; DestinationAddress : SOCKADDR_IN6* -> "var"
; RequestData : void* -> "sptr"
; RequestSize : WORD -> "int"
; RequestOptions : IP_OPTION_INFORMATION* optional -> "var"
; ReplyBuffer : void* out -> "sptr"
; ReplySize : DWORD -> "int"
; Timeout : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global Icmp6SendEcho2 "Icmp6SendEcho2" sptr, sptr, sptr, sptr, sptr, sptr, sptr, int, sptr, sptr, int, int
; res = Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, varptr(SourceAddress), varptr(DestinationAddress), RequestData, RequestSize, varptr(RequestOptions), ReplyBuffer, ReplySize, Timeout)
; IcmpHandle : HANDLE -> "sptr"
; Event : HANDLE optional -> "sptr"
; ApcRoutine : PIO_APC_ROUTINE optional -> "sptr"
; ApcContext : void* optional -> "sptr"
; SourceAddress : SOCKADDR_IN6* -> "sptr"
; DestinationAddress : SOCKADDR_IN6* -> "sptr"
; RequestData : void* -> "sptr"
; RequestSize : WORD -> "int"
; RequestOptions : IP_OPTION_INFORMATION* optional -> "sptr"
; ReplyBuffer : void* out -> "sptr"
; ReplySize : DWORD -> "int"
; Timeout : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD Icmp6SendEcho2(HANDLE IcmpHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, void* ApcContext, SOCKADDR_IN6* SourceAddress, SOCKADDR_IN6* DestinationAddress, void* RequestData, WORD RequestSize, IP_OPTION_INFORMATION* RequestOptions, void* ReplyBuffer, DWORD ReplySize, DWORD Timeout)
#uselib "IPHLPAPI.dll"
#cfunc global Icmp6SendEcho2 "Icmp6SendEcho2" intptr, intptr, intptr, intptr, var, var, intptr, int, var, intptr, int, int
; res = Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, SourceAddress, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
; IcmpHandle : HANDLE -> "intptr"
; Event : HANDLE optional -> "intptr"
; ApcRoutine : PIO_APC_ROUTINE optional -> "intptr"
; ApcContext : void* optional -> "intptr"
; SourceAddress : SOCKADDR_IN6* -> "var"
; DestinationAddress : SOCKADDR_IN6* -> "var"
; RequestData : void* -> "intptr"
; RequestSize : WORD -> "int"
; RequestOptions : IP_OPTION_INFORMATION* optional -> "var"
; ReplyBuffer : void* out -> "intptr"
; ReplySize : DWORD -> "int"
; Timeout : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD Icmp6SendEcho2(HANDLE IcmpHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, void* ApcContext, SOCKADDR_IN6* SourceAddress, SOCKADDR_IN6* DestinationAddress, void* RequestData, WORD RequestSize, IP_OPTION_INFORMATION* RequestOptions, void* ReplyBuffer, DWORD ReplySize, DWORD Timeout)
#uselib "IPHLPAPI.dll"
#cfunc global Icmp6SendEcho2 "Icmp6SendEcho2" intptr, intptr, intptr, intptr, intptr, intptr, intptr, int, intptr, intptr, int, int
; res = Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, varptr(SourceAddress), varptr(DestinationAddress), RequestData, RequestSize, varptr(RequestOptions), ReplyBuffer, ReplySize, Timeout)
; IcmpHandle : HANDLE -> "intptr"
; Event : HANDLE optional -> "intptr"
; ApcRoutine : PIO_APC_ROUTINE optional -> "intptr"
; ApcContext : void* optional -> "intptr"
; SourceAddress : SOCKADDR_IN6* -> "intptr"
; DestinationAddress : SOCKADDR_IN6* -> "intptr"
; RequestData : void* -> "intptr"
; RequestSize : WORD -> "int"
; RequestOptions : IP_OPTION_INFORMATION* optional -> "intptr"
; ReplyBuffer : void* out -> "intptr"
; ReplySize : DWORD -> "int"
; Timeout : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procIcmp6SendEcho2 = iphlpapi.NewProc("Icmp6SendEcho2")
)

// IcmpHandle (HANDLE), Event (HANDLE optional), ApcRoutine (PIO_APC_ROUTINE optional), ApcContext (void* optional), SourceAddress (SOCKADDR_IN6*), DestinationAddress (SOCKADDR_IN6*), RequestData (void*), RequestSize (WORD), RequestOptions (IP_OPTION_INFORMATION* optional), ReplyBuffer (void* out), ReplySize (DWORD), Timeout (DWORD)
r1, _, err := procIcmp6SendEcho2.Call(
	uintptr(IcmpHandle),
	uintptr(Event),
	uintptr(ApcRoutine),
	uintptr(ApcContext),
	uintptr(SourceAddress),
	uintptr(DestinationAddress),
	uintptr(RequestData),
	uintptr(RequestSize),
	uintptr(RequestOptions),
	uintptr(ReplyBuffer),
	uintptr(ReplySize),
	uintptr(Timeout),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function Icmp6SendEcho2(
  IcmpHandle: THandle;   // HANDLE
  Event: THandle;   // HANDLE optional
  ApcRoutine: Pointer;   // PIO_APC_ROUTINE optional
  ApcContext: Pointer;   // void* optional
  SourceAddress: Pointer;   // SOCKADDR_IN6*
  DestinationAddress: Pointer;   // SOCKADDR_IN6*
  RequestData: Pointer;   // void*
  RequestSize: Word;   // WORD
  RequestOptions: Pointer;   // IP_OPTION_INFORMATION* optional
  ReplyBuffer: Pointer;   // void* out
  ReplySize: DWORD;   // DWORD
  Timeout: DWORD   // DWORD
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'Icmp6SendEcho2';

result := DllCall("IPHLPAPI\Icmp6SendEcho2"
    , "Ptr", IcmpHandle   ; HANDLE
    , "Ptr", Event   ; HANDLE optional
    , "Ptr", ApcRoutine   ; PIO_APC_ROUTINE optional
    , "Ptr", ApcContext   ; void* optional
    , "Ptr", SourceAddress   ; SOCKADDR_IN6*
    , "Ptr", DestinationAddress   ; SOCKADDR_IN6*
    , "Ptr", RequestData   ; void*
    , "UShort", RequestSize   ; WORD
    , "Ptr", RequestOptions   ; IP_OPTION_INFORMATION* optional
    , "Ptr", ReplyBuffer   ; void* out
    , "UInt", ReplySize   ; DWORD
    , "UInt", Timeout   ; DWORD
    , "UInt")   ; return: DWORD

●Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, SourceAddress, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout) = DLL("IPHLPAPI.dll", "dword Icmp6SendEcho2(void*, void*, void*, void*, void*, void*, void*, int, void*, void*, dword, dword)")
# 呼び出し: Icmp6SendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, SourceAddress, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
# IcmpHandle : HANDLE -> "void*"
# Event : HANDLE optional -> "void*"
# ApcRoutine : PIO_APC_ROUTINE optional -> "void*"
# ApcContext : void* optional -> "void*"
# SourceAddress : SOCKADDR_IN6* -> "void*"
# DestinationAddress : SOCKADDR_IN6* -> "void*"
# RequestData : void* -> "void*"
# RequestSize : WORD -> "int"
# RequestOptions : IP_OPTION_INFORMATION* optional -> "void*"
# ReplyBuffer : void* out -> "void*"
# ReplySize : DWORD -> "dword"
# Timeout : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。