IcmpSendEcho2
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD IcmpSendEcho2(
HANDLE IcmpHandle,
HANDLE Event, // optional
PIO_APC_ROUTINE ApcRoutine, // optional
void* ApcContext, // optional
DWORD DestinationAddress,
void* RequestData,
WORD RequestSize,
IP_OPTION_INFORMATION* RequestOptions, // optional
void* ReplyBuffer,
DWORD ReplySize,
DWORD Timeout
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| IcmpHandle | HANDLE | in | ICMPCreateFile 関数が返した開いているハンドル。 |
| Event | HANDLE | inoptional | ICMP 応答が到着したときに(最大 1 回)シグナル状態になるイベント。このパラメーターを指定する場合は、有効なイベントオブジェクトへのハンドルが必要です。このイベントオブジェクトの作成には CreateEvent または CreateEventEx 関数を使用します。 イベントの使用方法の詳細については、Event objects を参照してください。 |
| ApcRoutine | PIO_APC_ROUTINE | inoptional | 呼び出し元スレッドがアラート可能状態にあり、かつ ICMPv4 応答が到着したときに呼び出されるルーチン。このパラメーターのデータ型を FARPROC ではなく PIO_APC_ROUTINE に強制するには、PIO_APC_ROUTINE_DEFINED が定義されている必要があります。 |
| ApcContext | void* | inoptional | ICMP 応答が到着したとき、またはエラーが発生したときに、ApcRoutine パラメーターで指定したコールバックルーチンへ(最大 1 回)渡される省略可能なパラメーター。 |
| DestinationAddress | DWORD | in | エコー要求の IPv4 宛先。IPAddr 構造体の形式で指定します。 |
| RequestData | void* | in | 要求として送信するデータを格納したバッファーへのポインター。 |
| RequestSize | WORD | in | RequestData パラメーターが指す要求データバッファーのサイズ(バイト単位)。 |
| RequestOptions | IP_OPTION_INFORMATION* | inoptional | 要求の IP ヘッダーオプションへのポインター。IP_OPTION_INFORMATION 構造体の形式で指定します。 IP ヘッダーオプションを指定する必要がない場合、このパラメーターは NULL でもかまいません。 |
| ReplyBuffer | void* | out | 要求に対する応答を保持するバッファーへのポインター。戻り時には、このバッファーに ICMP_ECHO_REPLY 構造体の配列と、それに続くオプションおよびデータが格納されます。 バッファーは、少なくとも 1 つの ICMP_ECHO_REPLY 構造体、RequestSize バイトのデータ、さらに追加の 8 バイトのデータ(ICMP エラーメッセージのサイズ)を保持できる大きさが必要です。 |
| ReplySize | DWORD | in | 応答バッファーに割り当てられたサイズ(バイト単位)。 バッファーは、少なくとも 1 つの ICMP_ECHO_REPLY 構造体、RequestSize バイトのデータ、さらに追加の 8 バイトのデータ(ICMP エラーメッセージのサイズ)を保持できる大きさが必要です。 |
| Timeout | DWORD | in | 応答を待機する時間(ミリ秒単位)。 |
戻り値の型: DWORD
公式ドキュメント
IcmpSendEcho2 関数は IPv4 ICMP エコー要求を送信し、(Event または ApcRoutine が非 NULL の場合は)即座に返るか、指定したタイムアウト後に返ります。ReplyBuffer には、応答があれば ICMP エコー応答が格納されます。
戻り値
同期的に呼び出された場合、IcmpSendEcho2 関数は受信して ReplyBuffer に格納した応答の数を返します。戻り値が 0 の場合、拡張エラー情報を得るには GetLastError を呼び出します。
非同期的に呼び出された場合、IcmpSendEcho2 関数は 0 を返します。続けて GetLastError を呼び出すと、操作が進行中であることを示す拡張エラーコード ERROR_IO_PENDING が返されます。結果は、Event パラメーターで指定したイベントがシグナル状態になったとき、または ApcRoutine パラメーターで指定したコールバック関数が呼び出されたときに、後で取得できます。
戻り値が 0 の場合、拡張エラー情報を得るには GetLastError を呼び出します。
関数が失敗した場合、GetLastError が返す拡張エラーコードは次の値のいずれかになります。
| 戻りコード | 説明 |
|---|---|
| ERROR_INVALID_PARAMETER | 無効なパラメーターが関数に渡されました。このエラーは、IcmpHandle パラメーターに無効なハンドルが含まれている場合に返されます。また、ReplySize パラメーターに ICMP_ECHO_REPLY 構造体のサイズより小さい値を指定した場合にも返されることがあります。 |
| ERROR_IO_PENDING | 操作が進行中です。この値は IcmpSendEcho2 への非同期呼び出しが成功した場合に返されるもので、エラーを示すものではありません。 |
| ERROR_NOT_ENOUGH_MEMORY | 操作を完了するための十分なメモリがありません。 |
| ERROR_NOT_SUPPORTED | 要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しない場合に返されます。 |
| IP_BUF_TOO_SMALL | ReplySize パラメーターで指定した ReplyBuffer のサイズが小さすぎました。 |
| Other | 返されたエラーのメッセージ文字列を取得するには、FormatMessage を使用します。 |
解説(Remarks)
IcmpSendEcho2 関数は、ApcRoutine または Event パラメーターが NULL の場合に同期的に呼び出されます。同期的に呼び出された場合、戻り値には、Timeout パラメーターで指定した時間だけ待機した後に受信して ReplyBuffer に格納された応答の数が含まれます。戻り値が 0 の場合、拡張エラー情報を得るには GetLastError を呼び出します。
IcmpSendEcho2 関数は、ApcRoutine または Event パラメーターのいずれかが指定されている場合に非同期的に呼び出されます。非同期的に呼び出された場合、応答を受け取るために ReplyBuffer および ReplySize パラメーターが必要です。ICMP 応答データは指定した ReplyBuffer にコピーされ、(Event パラメーターが指定されている場合は)アプリケーションにシグナルが送られるか、(ApcRoutine パラメーターが指定されている場合は)コールバック関数が呼び出されます。アプリケーションは、IcmpParseReplies 関数を使用して ReplyBuffer パラメーターが指すデータを解析する必要があります。
Event パラメーターが指定されている場合、IcmpSendEcho2 関数は非同期的に呼び出されます。ICMP 応答が到着すると、Event パラメーターで指定したイベントが(最大 1 回)シグナル状態になります。このイベントオブジェクトの作成には CreateEvent または CreateEventEx 関数を使用します。
ApcRoutine パラメーターが指定されている場合、IcmpSendEcho2 関数は非同期的に呼び出されます。ApcRoutine パラメーターはユーザー定義のコールバック関数を指す必要があります。ICMP 応答が到着すると、ApcRoutine パラメーターで指定したコールバック関数が(最大 1 回)呼び出されます。ApcRoutine パラメーターで指定したコールバック関数の呼び出しは直列化されます。
Event と ApcRoutine の両方のパラメーターが指定されている場合、ICMP 応答が到着すると Event パラメーターで指定したイベントが(最大 1 回)シグナル状態になりますが、ApcRoutine パラメーターで指定したコールバック関数は無視されます。
ApcRoutine パラメーターを使用して IcmpSendEcho2 関数を非同期的に呼び出すアプリケーションは、ApcRoutine パラメーターのデータ型を FARPROC ではなく PIO_APC_ROUTINE に強制するために PIO_APC_ROUTINE_DEFINED を定義する必要があります。
PIO_APC_ROUTINE_DEFINED は、Icmpapi.h ヘッダーファイルをインクルードする前に定義する必要があります。
ApcRoutine が指すコールバック関数は、次の構文で VOID 型の関数として定義する必要があります。
typedef
VOID WINAPI
(*PIO_APC_ROUTINE) (
IN PVOID ApcContext,
IN PIO_STATUS_BLOCK IoStatusBlock,
IN ULONG Reserved
);
コールバック関数に渡されるパラメーターには次のものがあります。
| パラメーター | 説明 |
|---|---|
| IN PVOID ApcContext | IcmpSendEcho2 関数に渡された AppContext パラメーター。このパラメーターは、コールバック関数が応答している IcmpSendEcho2 要求を識別するためにアプリケーションが使用できます。 |
| IN PIO_STATUS_BLOCK IoStatusBlock | IO_STATUS_BLOCK へのポインター。この変数には、最終的な完了ステータスと操作に関する情報が格納されます。応答で実際に受信したバイト数は、IO_STATUS_BLOCK 構造体の Information メンバーに返されます。 IO_STATUS_BLOCK 構造体は Wdm.h ヘッダーファイルで定義されています。 |
| IN ULONG Reserved | このパラメーターは予約されています。 |
ApcRoutine パラメーターで指定するコールバック関数は、IcmpSendEcho2 関数を呼び出すアプリケーションと同じプロセス内で実装する必要があります。コールバック関数が別の DLL にある場合は、IcmpSendEcho2 関数を呼び出す前にその DLL を読み込む必要があります。
IcmpSendEcho2 関数は Iphlpapi.dll からエクスポートされています。
IPv6 の場合は、Icmp6CreateFile、Icmp6SendEcho2、Icmp6ParseReplies 関数を使用します。
Iphlpapi.h ヘッダーファイルの include ディレクティブは、Icmpapi.h ヘッダーファイルのものよりも前に配置する必要があります。
例
次の例では、IcmpSendEcho2 関数を同期的に呼び出します。この例では、コマンドラインで指定した IP アドレスに ICMP エコー要求を送信し、最初の応答から受信した情報を出力します。
#include <winsock2.h>
#include <iphlpapi.h>
#include <icmpapi.h>
#include <stdio.h>
#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")
int __cdecl main(int argc, char **argv)
{
// Declare and initialize variables.
HANDLE hIcmpFile;
unsigned long ipaddr = INADDR_NONE;
DWORD dwRetVal = 0;
DWORD dwError = 0;
char SendData[] = "Data Buffer";
LPVOID ReplyBuffer = NULL;
DWORD ReplySize = 0;
// Validate the parameters.
if (argc != 2) {
printf("usage: %s IP address\n", argv[0]);
return 1;
}
ipaddr = inet_addr(argv[1]);
if (ipaddr == INADDR_NONE) {
printf("usage: %s IP address\n", argv[0]);
return 1;
}
hIcmpFile = IcmpCreateFile();
if (hIcmpFile == INVALID_HANDLE_VALUE) {
printf("\tUnable to open handle.\n");
printf("IcmpCreatefile returned error: %ld\n", GetLastError());
return 1;
}
// Allocate space for a single reply.
ReplySize = sizeof (ICMP_ECHO_REPLY) + sizeof (SendData) + 8;
ReplyBuffer = (VOID *) malloc(ReplySize);
if (ReplyBuffer == NULL) {
printf("\tUnable to allocate memory for reply buffer\n");
return 1;
}
dwRetVal = IcmpSendEcho2(hIcmpFile, NULL, NULL, NULL,
ipaddr, SendData, sizeof (SendData), NULL,
ReplyBuffer, ReplySize, 1000);
if (dwRetVal != 0) {
PICMP_ECHO_REPLY pEchoReply = (PICMP_ECHO_REPLY) ReplyBuffer;
struct in_addr ReplyAddr;
ReplyAddr.S_un.S_addr = pEchoReply->Address;
printf("\tSent icmp message to %s\n", argv[1]);
if (dwRetVal > 1) {
printf("\tReceived %ld icmp message responses\n", dwRetVal);
printf("\tInformation from the first response:\n");
} else {
printf("\tReceived %ld icmp message response\n", dwRetVal);
printf("\tInformation from this response:\n");
}
printf("\t Received from %s\n", inet_ntoa(ReplyAddr));
printf("\t Status = %ld ", pEchoReply->Status);
switch (pEchoReply->Status) {
case IP_DEST_HOST_UNREACHABLE:
printf("(Destination host was unreachable)\n");
break;
case IP_DEST_NET_UNREACHABLE:
printf("(Destination Network was unreachable)\n");
break;
case IP_REQ_TIMED_OUT:
printf("(Request timed out)\n");
break;
default:
printf("\n");
break;
}
printf("\t Roundtrip time = %ld milliseconds\n",
pEchoReply->RoundTripTime);
} else {
printf("Call to IcmpSendEcho2 failed.\n");
dwError = GetLastError();
switch (dwError) {
case IP_BUF_TOO_SMALL:
printf("\tReplyBufferSize too small\n");
break;
case IP_REQ_TIMED_OUT:
printf("\tRequest timed out\n");
break;
default:
printf("\tExtended error returned: %ld\n", dwError);
break;
}
return 1;
}
return 0;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
DWORD IcmpSendEcho2(
HANDLE IcmpHandle,
HANDLE Event, // optional
PIO_APC_ROUTINE ApcRoutine, // optional
void* ApcContext, // optional
DWORD 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 IcmpSendEcho2(
IntPtr IcmpHandle, // HANDLE
IntPtr Event, // HANDLE optional
IntPtr ApcRoutine, // PIO_APC_ROUTINE optional
IntPtr ApcContext, // void* optional
uint DestinationAddress, // DWORD
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 IcmpSendEcho2(
IcmpHandle As IntPtr, ' HANDLE
[Event] As IntPtr, ' HANDLE optional
ApcRoutine As IntPtr, ' PIO_APC_ROUTINE optional
ApcContext As IntPtr, ' void* optional
DestinationAddress As UInteger, ' DWORD
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
' DestinationAddress : DWORD
' RequestData : void*
' RequestSize : WORD
' RequestOptions : IP_OPTION_INFORMATION* optional
' ReplyBuffer : void* out
' ReplySize : DWORD
' Timeout : DWORD
Declare PtrSafe Function IcmpSendEcho2 Lib "iphlpapi" ( _
ByVal IcmpHandle As LongPtr, _
ByVal Event As LongPtr, _
ByVal ApcRoutine As LongPtr, _
ByVal ApcContext As LongPtr, _
ByVal DestinationAddress As Long, _
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
IcmpSendEcho2 = ctypes.windll.iphlpapi.IcmpSendEcho2
IcmpSendEcho2.restype = wintypes.DWORD
IcmpSendEcho2.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
wintypes.DWORD, # DestinationAddress : DWORD
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')
IcmpSendEcho2 = Fiddle::Function.new(
lib['IcmpSendEcho2'],
[
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_INT, # DestinationAddress : DWORD
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 IcmpSendEcho2(
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
DestinationAddress: u32, // DWORD
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 IcmpSendEcho2(IntPtr IcmpHandle, IntPtr Event, IntPtr ApcRoutine, IntPtr ApcContext, uint DestinationAddress, IntPtr RequestData, ushort RequestSize, IntPtr RequestOptions, IntPtr ReplyBuffer, uint ReplySize, uint Timeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_IcmpSendEcho2' -Namespace Win32 -PassThru
# $api::IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)#uselib "IPHLPAPI.dll"
#func global IcmpSendEcho2 "IcmpSendEcho2" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; IcmpSendEcho2 IcmpHandle, Event, ApcRoutine, ApcContext, 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"
; DestinationAddress : DWORD -> "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 IcmpSendEcho2 "IcmpSendEcho2" sptr, sptr, sptr, sptr, int, sptr, int, var, sptr, int, int ; res = IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout) ; IcmpHandle : HANDLE -> "sptr" ; Event : HANDLE optional -> "sptr" ; ApcRoutine : PIO_APC_ROUTINE optional -> "sptr" ; ApcContext : void* optional -> "sptr" ; DestinationAddress : DWORD -> "int" ; 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 IcmpSendEcho2 "IcmpSendEcho2" sptr, sptr, sptr, sptr, int, sptr, int, sptr, sptr, int, int ; res = IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, 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" ; DestinationAddress : DWORD -> "int" ; 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 IcmpSendEcho2(HANDLE IcmpHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, void* ApcContext, DWORD DestinationAddress, void* RequestData, WORD RequestSize, IP_OPTION_INFORMATION* RequestOptions, void* ReplyBuffer, DWORD ReplySize, DWORD Timeout) #uselib "IPHLPAPI.dll" #cfunc global IcmpSendEcho2 "IcmpSendEcho2" intptr, intptr, intptr, intptr, int, intptr, int, var, intptr, int, int ; res = IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout) ; IcmpHandle : HANDLE -> "intptr" ; Event : HANDLE optional -> "intptr" ; ApcRoutine : PIO_APC_ROUTINE optional -> "intptr" ; ApcContext : void* optional -> "intptr" ; DestinationAddress : DWORD -> "int" ; 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 IcmpSendEcho2(HANDLE IcmpHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, void* ApcContext, DWORD DestinationAddress, void* RequestData, WORD RequestSize, IP_OPTION_INFORMATION* RequestOptions, void* ReplyBuffer, DWORD ReplySize, DWORD Timeout) #uselib "IPHLPAPI.dll" #cfunc global IcmpSendEcho2 "IcmpSendEcho2" intptr, intptr, intptr, intptr, int, intptr, int, intptr, intptr, int, int ; res = IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, 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" ; DestinationAddress : DWORD -> "int" ; 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")
procIcmpSendEcho2 = iphlpapi.NewProc("IcmpSendEcho2")
)
// IcmpHandle (HANDLE), Event (HANDLE optional), ApcRoutine (PIO_APC_ROUTINE optional), ApcContext (void* optional), DestinationAddress (DWORD), RequestData (void*), RequestSize (WORD), RequestOptions (IP_OPTION_INFORMATION* optional), ReplyBuffer (void* out), ReplySize (DWORD), Timeout (DWORD)
r1, _, err := procIcmpSendEcho2.Call(
uintptr(IcmpHandle),
uintptr(Event),
uintptr(ApcRoutine),
uintptr(ApcContext),
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 // DWORDfunction IcmpSendEcho2(
IcmpHandle: THandle; // HANDLE
Event: THandle; // HANDLE optional
ApcRoutine: Pointer; // PIO_APC_ROUTINE optional
ApcContext: Pointer; // void* optional
DestinationAddress: DWORD; // DWORD
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 'IcmpSendEcho2';result := DllCall("IPHLPAPI\IcmpSendEcho2"
, "Ptr", IcmpHandle ; HANDLE
, "Ptr", Event ; HANDLE optional
, "Ptr", ApcRoutine ; PIO_APC_ROUTINE optional
, "Ptr", ApcContext ; void* optional
, "UInt", DestinationAddress ; DWORD
, "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●IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout) = DLL("IPHLPAPI.dll", "dword IcmpSendEcho2(void*, void*, void*, void*, dword, void*, int, void*, void*, dword, dword)")
# 呼び出し: IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
# IcmpHandle : HANDLE -> "void*"
# Event : HANDLE optional -> "void*"
# ApcRoutine : PIO_APC_ROUTINE optional -> "void*"
# ApcContext : void* optional -> "void*"
# DestinationAddress : DWORD -> "dword"
# 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)。const std = @import("std");
extern "iphlpapi" fn IcmpSendEcho2(
IcmpHandle: ?*anyopaque, // HANDLE
Event: ?*anyopaque, // HANDLE optional
ApcRoutine: ?*anyopaque, // PIO_APC_ROUTINE optional
ApcContext: ?*anyopaque, // void* optional
DestinationAddress: u32, // DWORD
RequestData: ?*anyopaque, // void*
RequestSize: u16, // WORD
RequestOptions: [*c]IP_OPTION_INFORMATION, // IP_OPTION_INFORMATION* optional
ReplyBuffer: ?*anyopaque, // void* out
ReplySize: u32, // DWORD
Timeout: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc IcmpSendEcho2(
IcmpHandle: pointer, # HANDLE
Event: pointer, # HANDLE optional
ApcRoutine: pointer, # PIO_APC_ROUTINE optional
ApcContext: pointer, # void* optional
DestinationAddress: uint32, # DWORD
RequestData: pointer, # void*
RequestSize: uint16, # WORD
RequestOptions: ptr IP_OPTION_INFORMATION, # IP_OPTION_INFORMATION* optional
ReplyBuffer: pointer, # void* out
ReplySize: uint32, # DWORD
Timeout: uint32 # DWORD
): uint32 {.importc: "IcmpSendEcho2", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint IcmpSendEcho2(
void* IcmpHandle, // HANDLE
void* Event, // HANDLE optional
void* ApcRoutine, // PIO_APC_ROUTINE optional
void* ApcContext, // void* optional
uint DestinationAddress, // DWORD
void* RequestData, // void*
ushort RequestSize, // WORD
IP_OPTION_INFORMATION* RequestOptions, // IP_OPTION_INFORMATION* optional
void* ReplyBuffer, // void* out
uint ReplySize, // DWORD
uint Timeout // DWORD
);ccall((:IcmpSendEcho2, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{Cvoid}, UInt16, Ptr{IP_OPTION_INFORMATION}, Ptr{Cvoid}, UInt32, UInt32),
IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
# IcmpHandle : HANDLE -> Ptr{Cvoid}
# Event : HANDLE optional -> Ptr{Cvoid}
# ApcRoutine : PIO_APC_ROUTINE optional -> Ptr{Cvoid}
# ApcContext : void* optional -> Ptr{Cvoid}
# DestinationAddress : DWORD -> UInt32
# RequestData : void* -> Ptr{Cvoid}
# RequestSize : WORD -> UInt16
# RequestOptions : IP_OPTION_INFORMATION* optional -> Ptr{IP_OPTION_INFORMATION}
# ReplyBuffer : void* out -> Ptr{Cvoid}
# ReplySize : DWORD -> UInt32
# Timeout : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t IcmpSendEcho2(
void* IcmpHandle,
void* Event,
void* ApcRoutine,
void* ApcContext,
uint32_t DestinationAddress,
void* RequestData,
uint16_t RequestSize,
void* RequestOptions,
void* ReplyBuffer,
uint32_t ReplySize,
uint32_t Timeout);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
-- IcmpHandle : HANDLE
-- Event : HANDLE optional
-- ApcRoutine : PIO_APC_ROUTINE optional
-- ApcContext : void* optional
-- DestinationAddress : DWORD
-- RequestData : void*
-- RequestSize : WORD
-- RequestOptions : IP_OPTION_INFORMATION* optional
-- ReplyBuffer : void* out
-- ReplySize : DWORD
-- Timeout : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const IcmpSendEcho2 = lib.func('__stdcall', 'IcmpSendEcho2', 'uint32_t', ['void *', 'void *', 'void *', 'void *', 'uint32_t', 'void *', 'uint16_t', 'void *', 'void *', 'uint32_t', 'uint32_t']);
// IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
// IcmpHandle : HANDLE -> 'void *'
// Event : HANDLE optional -> 'void *'
// ApcRoutine : PIO_APC_ROUTINE optional -> 'void *'
// ApcContext : void* optional -> 'void *'
// DestinationAddress : DWORD -> 'uint32_t'
// RequestData : void* -> 'void *'
// RequestSize : WORD -> 'uint16_t'
// RequestOptions : IP_OPTION_INFORMATION* optional -> 'void *'
// ReplyBuffer : void* out -> 'void *'
// ReplySize : DWORD -> 'uint32_t'
// Timeout : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("IPHLPAPI.dll", {
IcmpSendEcho2: { parameters: ["pointer", "pointer", "pointer", "pointer", "u32", "pointer", "u16", "pointer", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout)
// IcmpHandle : HANDLE -> "pointer"
// Event : HANDLE optional -> "pointer"
// ApcRoutine : PIO_APC_ROUTINE optional -> "pointer"
// ApcContext : void* optional -> "pointer"
// DestinationAddress : DWORD -> "u32"
// RequestData : void* -> "pointer"
// RequestSize : WORD -> "u16"
// RequestOptions : IP_OPTION_INFORMATION* optional -> "pointer"
// ReplyBuffer : void* out -> "pointer"
// ReplySize : DWORD -> "u32"
// Timeout : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t IcmpSendEcho2(
void* IcmpHandle,
void* Event,
void* ApcRoutine,
void* ApcContext,
uint32_t DestinationAddress,
void* RequestData,
uint16_t RequestSize,
void* RequestOptions,
void* ReplyBuffer,
uint32_t ReplySize,
uint32_t Timeout);
C, "IPHLPAPI.dll");
// $ffi->IcmpSendEcho2(IcmpHandle, Event, ApcRoutine, ApcContext, DestinationAddress, RequestData, RequestSize, RequestOptions, ReplyBuffer, ReplySize, Timeout);
// IcmpHandle : HANDLE
// Event : HANDLE optional
// ApcRoutine : PIO_APC_ROUTINE optional
// ApcContext : void* optional
// DestinationAddress : DWORD
// RequestData : void*
// RequestSize : WORD
// RequestOptions : IP_OPTION_INFORMATION* optional
// ReplyBuffer : void* out
// ReplySize : DWORD
// Timeout : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Iphlpapi extends StdCallLibrary {
Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
int IcmpSendEcho2(
Pointer IcmpHandle, // HANDLE
Pointer Event, // HANDLE optional
Callback ApcRoutine, // PIO_APC_ROUTINE optional
Pointer ApcContext, // void* optional
int DestinationAddress, // DWORD
Pointer RequestData, // void*
short RequestSize, // WORD
Pointer RequestOptions, // IP_OPTION_INFORMATION* optional
Pointer ReplyBuffer, // void* out
int ReplySize, // DWORD
int Timeout // DWORD
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun IcmpSendEcho2 = IcmpSendEcho2(
IcmpHandle : Void*, # HANDLE
Event : Void*, # HANDLE optional
ApcRoutine : Void*, # PIO_APC_ROUTINE optional
ApcContext : Void*, # void* optional
DestinationAddress : UInt32, # DWORD
RequestData : Void*, # void*
RequestSize : UInt16, # WORD
RequestOptions : IP_OPTION_INFORMATION*, # IP_OPTION_INFORMATION* optional
ReplyBuffer : Void*, # void* out
ReplySize : UInt32, # DWORD
Timeout : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef IcmpSendEcho2Native = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>, Uint16, Pointer<Void>, Pointer<Void>, Uint32, Uint32);
typedef IcmpSendEcho2Dart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>, int, Pointer<Void>, int, Pointer<Void>, Pointer<Void>, int, int);
final IcmpSendEcho2 = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<IcmpSendEcho2Native, IcmpSendEcho2Dart>('IcmpSendEcho2');
// IcmpHandle : HANDLE -> Pointer<Void>
// Event : HANDLE optional -> Pointer<Void>
// ApcRoutine : PIO_APC_ROUTINE optional -> Pointer<Void>
// ApcContext : void* optional -> Pointer<Void>
// DestinationAddress : DWORD -> Uint32
// RequestData : void* -> Pointer<Void>
// RequestSize : WORD -> Uint16
// RequestOptions : IP_OPTION_INFORMATION* optional -> Pointer<Void>
// ReplyBuffer : void* out -> Pointer<Void>
// ReplySize : DWORD -> Uint32
// Timeout : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function IcmpSendEcho2(
IcmpHandle: THandle; // HANDLE
Event: THandle; // HANDLE optional
ApcRoutine: Pointer; // PIO_APC_ROUTINE optional
ApcContext: Pointer; // void* optional
DestinationAddress: DWORD; // DWORD
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 'IcmpSendEcho2';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "IcmpSendEcho2"
c_IcmpSendEcho2 :: Ptr () -> Ptr () -> Ptr () -> Ptr () -> Word32 -> Ptr () -> Word16 -> Ptr () -> Ptr () -> Word32 -> Word32 -> IO Word32
-- IcmpHandle : HANDLE -> Ptr ()
-- Event : HANDLE optional -> Ptr ()
-- ApcRoutine : PIO_APC_ROUTINE optional -> Ptr ()
-- ApcContext : void* optional -> Ptr ()
-- DestinationAddress : DWORD -> Word32
-- RequestData : void* -> Ptr ()
-- RequestSize : WORD -> Word16
-- RequestOptions : IP_OPTION_INFORMATION* optional -> Ptr ()
-- ReplyBuffer : void* out -> Ptr ()
-- ReplySize : DWORD -> Word32
-- Timeout : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let icmpsendecho2 =
foreign "IcmpSendEcho2"
((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> uint16_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* IcmpHandle : HANDLE -> (ptr void) *)
(* Event : HANDLE optional -> (ptr void) *)
(* ApcRoutine : PIO_APC_ROUTINE optional -> (ptr void) *)
(* ApcContext : void* optional -> (ptr void) *)
(* DestinationAddress : DWORD -> uint32_t *)
(* RequestData : void* -> (ptr void) *)
(* RequestSize : WORD -> uint16_t *)
(* RequestOptions : IP_OPTION_INFORMATION* optional -> (ptr void) *)
(* ReplyBuffer : void* out -> (ptr void) *)
(* ReplySize : DWORD -> uint32_t *)
(* Timeout : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("IcmpSendEcho2" icmp-send-echo2 :convention :stdcall) :uint32
(icmp-handle :pointer) ; HANDLE
(event :pointer) ; HANDLE optional
(apc-routine :pointer) ; PIO_APC_ROUTINE optional
(apc-context :pointer) ; void* optional
(destination-address :uint32) ; DWORD
(request-data :pointer) ; void*
(request-size :uint16) ; WORD
(request-options :pointer) ; IP_OPTION_INFORMATION* optional
(reply-buffer :pointer) ; void* out
(reply-size :uint32) ; DWORD
(timeout :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $IcmpSendEcho2 = Win32::API::More->new('IPHLPAPI',
'DWORD IcmpSendEcho2(HANDLE IcmpHandle, HANDLE Event, LPVOID ApcRoutine, LPVOID ApcContext, DWORD DestinationAddress, LPVOID RequestData, WORD RequestSize, LPVOID RequestOptions, LPVOID ReplyBuffer, DWORD ReplySize, DWORD Timeout)');
# my $ret = $IcmpSendEcho2->Call($IcmpHandle, $Event, $ApcRoutine, $ApcContext, $DestinationAddress, $RequestData, $RequestSize, $RequestOptions, $ReplyBuffer, $ReplySize, $Timeout);
# IcmpHandle : HANDLE -> HANDLE
# Event : HANDLE optional -> HANDLE
# ApcRoutine : PIO_APC_ROUTINE optional -> LPVOID
# ApcContext : void* optional -> LPVOID
# DestinationAddress : DWORD -> DWORD
# RequestData : void* -> LPVOID
# RequestSize : WORD -> WORD
# RequestOptions : IP_OPTION_INFORMATION* optional -> LPVOID
# ReplyBuffer : void* out -> LPVOID
# ReplySize : DWORD -> DWORD
# Timeout : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
- f IcmpSendEcho — 指定先へICMPエコー要求を送信し応答を受信する。
- f IcmpSendEcho2Ex — 送信元アドレスを指定してICMPエコー要求を送信する。