ホーム › NetworkManagement.IpHelper › Icmp6ParseReplies
Icmp6ParseReplies
関数ICMPv6エコー応答バッファを解析し応答数を返す。
シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD Icmp6ParseReplies(
void* ReplyBuffer,
DWORD ReplySize
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| ReplyBuffer | void* | out | Icmp6SendEcho2 関数に渡されたバッファーへのポインター。このパラメーターは、応答を保持する ICMPV6_ECHO_REPLY 構造体を指します。 |
| ReplySize | DWORD | in | ReplyBuffer パラメーターが指すバッファーのサイズ (バイト単位)。 |
戻り値の型: DWORD
公式ドキュメント
Icmp6ParseReplies 関数は、指定された応答バッファーを解析し、IPv6 ICMPv6 エコー応答が見つかった場合はそれを返します。
戻り値
Icmp6ParseReplies 関数は、成功すると 1 を返します。この場合、ReplyBuffer パラメーターが指す ICMPV6_ECHO_REPLY 構造体の Status メンバーは、ターゲットノードが応答した場合は IP_SUCCESS、または IP_TTL_EXPIRED_TRANSIT のいずれかになります。
戻り値が 0 の場合、拡張エラー情報は GetLastError から取得できます。
| 戻りコード | 説明 |
|---|---|
| 一般的な失敗が発生しました。このエラーは、ReplyBuffer パラメーターが NULL ポインターである場合、または ReplySize パラメーターが 0 の場合に返されます。 | |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。 |
解説(Remarks)
Icmp6ParseReplies 関数は、ICMPv6 エコー要求の結果として得られる応答を解析するために IPv6 で使用されます。Icmp6ParseReplies 関数は、以前に Icmp6SendEcho2 関数に渡された応答バッファーを解析します。Icmp6ParseReplies 関数は、Icmp6SendEcho2 関数とのみ併用してください。
Icmp6ParseReplies 関数は、IPv4 用に以前に IcmpSendEcho または IcmpSendEcho2 に渡された応答バッファーには使用できません。
IPv4 の場合は、IcmpCreateFile、IcmpSendEcho、IcmpSendEcho2、IcmpSendEcho2Ex、IcmpParseReplies の各関数を使用してください。
Iphlpapi.h ヘッダーファイルの include ディレクティブは、Icmpapi.h ヘッダーファイルよりも前に配置する必要があることに注意してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
DWORD Icmp6ParseReplies(
void* ReplyBuffer,
DWORD ReplySize
);[DllImport("IPHLPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern uint Icmp6ParseReplies(
IntPtr ReplyBuffer, // void* out
uint ReplySize // DWORD
);<DllImport("IPHLPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function Icmp6ParseReplies(
ReplyBuffer As IntPtr, ' void* out
ReplySize As UInteger ' DWORD
) As UInteger
End Function' ReplyBuffer : void* out
' ReplySize : DWORD
Declare PtrSafe Function Icmp6ParseReplies Lib "iphlpapi" ( _
ByVal ReplyBuffer As LongPtr, _
ByVal ReplySize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
Icmp6ParseReplies = ctypes.windll.iphlpapi.Icmp6ParseReplies
Icmp6ParseReplies.restype = wintypes.DWORD
Icmp6ParseReplies.argtypes = [
ctypes.POINTER(None), # ReplyBuffer : void* out
wintypes.DWORD, # ReplySize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
Icmp6ParseReplies = Fiddle::Function.new(
lib['Icmp6ParseReplies'],
[
Fiddle::TYPE_VOIDP, # ReplyBuffer : void* out
-Fiddle::TYPE_INT, # ReplySize : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn Icmp6ParseReplies(
ReplyBuffer: *mut (), // void* out
ReplySize: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll", SetLastError = true)]
public static extern uint Icmp6ParseReplies(IntPtr ReplyBuffer, uint ReplySize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_Icmp6ParseReplies' -Namespace Win32 -PassThru
# $api::Icmp6ParseReplies(ReplyBuffer, ReplySize)#uselib "IPHLPAPI.dll"
#func global Icmp6ParseReplies "Icmp6ParseReplies" sptr, sptr
; Icmp6ParseReplies ReplyBuffer, ReplySize ; 戻り値は stat
; ReplyBuffer : void* out -> "sptr"
; ReplySize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll"
#cfunc global Icmp6ParseReplies "Icmp6ParseReplies" sptr, int
; res = Icmp6ParseReplies(ReplyBuffer, ReplySize)
; ReplyBuffer : void* out -> "sptr"
; ReplySize : DWORD -> "int"; DWORD Icmp6ParseReplies(void* ReplyBuffer, DWORD ReplySize)
#uselib "IPHLPAPI.dll"
#cfunc global Icmp6ParseReplies "Icmp6ParseReplies" intptr, int
; res = Icmp6ParseReplies(ReplyBuffer, ReplySize)
; ReplyBuffer : void* out -> "intptr"
; ReplySize : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procIcmp6ParseReplies = iphlpapi.NewProc("Icmp6ParseReplies")
)
// ReplyBuffer (void* out), ReplySize (DWORD)
r1, _, err := procIcmp6ParseReplies.Call(
uintptr(ReplyBuffer),
uintptr(ReplySize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction Icmp6ParseReplies(
ReplyBuffer: Pointer; // void* out
ReplySize: DWORD // DWORD
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'Icmp6ParseReplies';result := DllCall("IPHLPAPI\Icmp6ParseReplies"
, "Ptr", ReplyBuffer ; void* out
, "UInt", ReplySize ; DWORD
, "UInt") ; return: DWORD●Icmp6ParseReplies(ReplyBuffer, ReplySize) = DLL("IPHLPAPI.dll", "dword Icmp6ParseReplies(void*, dword)")
# 呼び出し: Icmp6ParseReplies(ReplyBuffer, ReplySize)
# ReplyBuffer : void* out -> "void*"
# ReplySize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn Icmp6ParseReplies(
ReplyBuffer: ?*anyopaque, // void* out
ReplySize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc Icmp6ParseReplies(
ReplyBuffer: pointer, # void* out
ReplySize: uint32 # DWORD
): uint32 {.importc: "Icmp6ParseReplies", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint Icmp6ParseReplies(
void* ReplyBuffer, // void* out
uint ReplySize // DWORD
);ccall((:Icmp6ParseReplies, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, UInt32),
ReplyBuffer, ReplySize)
# ReplyBuffer : void* out -> Ptr{Cvoid}
# ReplySize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t Icmp6ParseReplies(
void* ReplyBuffer,
uint32_t ReplySize);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.Icmp6ParseReplies(ReplyBuffer, ReplySize)
-- ReplyBuffer : void* out
-- ReplySize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const Icmp6ParseReplies = lib.func('__stdcall', 'Icmp6ParseReplies', 'uint32_t', ['void *', 'uint32_t']);
// Icmp6ParseReplies(ReplyBuffer, ReplySize)
// ReplyBuffer : void* out -> 'void *'
// ReplySize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
Icmp6ParseReplies: { parameters: ["pointer", "u32"], result: "u32" },
});
// lib.symbols.Icmp6ParseReplies(ReplyBuffer, ReplySize)
// ReplyBuffer : void* out -> "pointer"
// ReplySize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t Icmp6ParseReplies(
void* ReplyBuffer,
uint32_t ReplySize);
C, "IPHLPAPI.dll");
// $ffi->Icmp6ParseReplies(ReplyBuffer, ReplySize);
// ReplyBuffer : void* out
// ReplySize : 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 Icmp6ParseReplies(
Pointer ReplyBuffer, // void* out
int ReplySize // DWORD
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun Icmp6ParseReplies = Icmp6ParseReplies(
ReplyBuffer : Void*, # void* out
ReplySize : 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 Icmp6ParseRepliesNative = Uint32 Function(Pointer<Void>, Uint32);
typedef Icmp6ParseRepliesDart = int Function(Pointer<Void>, int);
final Icmp6ParseReplies = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<Icmp6ParseRepliesNative, Icmp6ParseRepliesDart>('Icmp6ParseReplies');
// ReplyBuffer : void* out -> Pointer<Void>
// ReplySize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function Icmp6ParseReplies(
ReplyBuffer: Pointer; // void* out
ReplySize: DWORD // DWORD
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'Icmp6ParseReplies';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "Icmp6ParseReplies"
c_Icmp6ParseReplies :: Ptr () -> Word32 -> IO Word32
-- ReplyBuffer : void* out -> Ptr ()
-- ReplySize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let icmp6parsereplies =
foreign "Icmp6ParseReplies"
((ptr void) @-> uint32_t @-> returning uint32_t)
(* ReplyBuffer : void* out -> (ptr void) *)
(* ReplySize : 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 ("Icmp6ParseReplies" icmp6-parse-replies :convention :stdcall) :uint32
(reply-buffer :pointer) ; void* out
(reply-size :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $Icmp6ParseReplies = Win32::API::More->new('IPHLPAPI',
'DWORD Icmp6ParseReplies(LPVOID ReplyBuffer, DWORD ReplySize)');
# my $ret = $Icmp6ParseReplies->Call($ReplyBuffer, $ReplySize);
# ReplyBuffer : void* out -> LPVOID
# ReplySize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f GetLastError — 呼び出しスレッドの最終エラーコードを取得する。
- s ICMPV6_ECHO_REPLY_LH
- s ICMP_ECHO_REPLY
- f Icmp6CreateFile — ICMPv6エコー要求送信用のハンドルを作成する。
- f Icmp6SendEcho2 — IPv6でICMPv6エコー要求を送信し応答を受信する。
- f IcmpCloseHandle — ICMPエコー要求用に開いたハンドルを閉じる。
- f IcmpCreateFile — ICMPエコー要求送信用のハンドルを作成する。
- f IcmpParseReplies — ICMPエコー応答バッファを解析し応答数を返す。
- f IcmpSendEcho2 — ICMPエコー要求を同期または非同期で送信する。
- f IcmpSendEcho2Ex — 送信元アドレスを指定してICMPエコー要求を送信する。