ホーム › NetworkManagement.IpHelper › GetUniDirectionalAdapterInfo
GetUniDirectionalAdapterInfo
関数単方向アダプターのアドレス情報を取得する。
シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD GetUniDirectionalAdapterInfo(
IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* pIPIfInfo, // optional
DWORD* dwOutBufLen
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pIPIfInfo | IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* | outoptional | ローカルコンピューターにインストールされている単方向アダプターに関する情報を受け取る IP_UNIDIRECTIONAL_ADAPTER_ADDRESS 構造体へのポインターです。 |
| dwOutBufLen | DWORD* | inout | pIPIfInfo パラメーターが指す構造体のサイズを受け取る ULONG 変数へのポインターです。 |
戻り値の型: DWORD
公式ドキュメント
GetUniDirectionalAdapterInfo 関数は、ローカルコンピューターにインストールされている単方向アダプターに関する情報を取得します。単方向アダプターとは、データグラムを受信できるが送信できないアダプターのことです。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetUniDirectionalAdapterInfo(
IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* pIPIfInfo, // optional
DWORD* dwOutBufLen
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetUniDirectionalAdapterInfo(
IntPtr pIPIfInfo, // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
ref uint dwOutBufLen // DWORD* in/out
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetUniDirectionalAdapterInfo(
pIPIfInfo As IntPtr, ' IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
ByRef dwOutBufLen As UInteger ' DWORD* in/out
) As UInteger
End Function' pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
' dwOutBufLen : DWORD* in/out
Declare PtrSafe Function GetUniDirectionalAdapterInfo Lib "iphlpapi" ( _
ByVal pIPIfInfo As LongPtr, _
ByRef dwOutBufLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetUniDirectionalAdapterInfo = ctypes.windll.iphlpapi.GetUniDirectionalAdapterInfo
GetUniDirectionalAdapterInfo.restype = wintypes.DWORD
GetUniDirectionalAdapterInfo.argtypes = [
ctypes.c_void_p, # pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
ctypes.POINTER(wintypes.DWORD), # dwOutBufLen : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
GetUniDirectionalAdapterInfo = Fiddle::Function.new(
lib['GetUniDirectionalAdapterInfo'],
[
Fiddle::TYPE_VOIDP, # pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
Fiddle::TYPE_VOIDP, # dwOutBufLen : DWORD* in/out
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn GetUniDirectionalAdapterInfo(
pIPIfInfo: *mut IP_UNIDIRECTIONAL_ADAPTER_ADDRESS, // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
dwOutBufLen: *mut u32 // DWORD* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetUniDirectionalAdapterInfo(IntPtr pIPIfInfo, ref uint dwOutBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetUniDirectionalAdapterInfo' -Namespace Win32 -PassThru
# $api::GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen)#uselib "IPHLPAPI.dll"
#func global GetUniDirectionalAdapterInfo "GetUniDirectionalAdapterInfo" sptr, sptr
; GetUniDirectionalAdapterInfo varptr(pIPIfInfo), varptr(dwOutBufLen) ; 戻り値は stat
; pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "sptr"
; dwOutBufLen : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "IPHLPAPI.dll" #cfunc global GetUniDirectionalAdapterInfo "GetUniDirectionalAdapterInfo" var, var ; res = GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen) ; pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "var" ; dwOutBufLen : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global GetUniDirectionalAdapterInfo "GetUniDirectionalAdapterInfo" sptr, sptr ; res = GetUniDirectionalAdapterInfo(varptr(pIPIfInfo), varptr(dwOutBufLen)) ; pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "sptr" ; dwOutBufLen : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD GetUniDirectionalAdapterInfo(IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* pIPIfInfo, DWORD* dwOutBufLen) #uselib "IPHLPAPI.dll" #cfunc global GetUniDirectionalAdapterInfo "GetUniDirectionalAdapterInfo" var, var ; res = GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen) ; pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "var" ; dwOutBufLen : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetUniDirectionalAdapterInfo(IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* pIPIfInfo, DWORD* dwOutBufLen) #uselib "IPHLPAPI.dll" #cfunc global GetUniDirectionalAdapterInfo "GetUniDirectionalAdapterInfo" intptr, intptr ; res = GetUniDirectionalAdapterInfo(varptr(pIPIfInfo), varptr(dwOutBufLen)) ; pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "intptr" ; dwOutBufLen : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procGetUniDirectionalAdapterInfo = iphlpapi.NewProc("GetUniDirectionalAdapterInfo")
)
// pIPIfInfo (IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out), dwOutBufLen (DWORD* in/out)
r1, _, err := procGetUniDirectionalAdapterInfo.Call(
uintptr(pIPIfInfo),
uintptr(dwOutBufLen),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetUniDirectionalAdapterInfo(
pIPIfInfo: Pointer; // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
dwOutBufLen: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetUniDirectionalAdapterInfo';result := DllCall("IPHLPAPI\GetUniDirectionalAdapterInfo"
, "Ptr", pIPIfInfo ; IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
, "Ptr", dwOutBufLen ; DWORD* in/out
, "UInt") ; return: DWORD●GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen) = DLL("IPHLPAPI.dll", "dword GetUniDirectionalAdapterInfo(void*, void*)")
# 呼び出し: GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen)
# pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "void*"
# dwOutBufLen : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn GetUniDirectionalAdapterInfo(
pIPIfInfo: [*c]IP_UNIDIRECTIONAL_ADAPTER_ADDRESS, // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
dwOutBufLen: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;proc GetUniDirectionalAdapterInfo(
pIPIfInfo: ptr IP_UNIDIRECTIONAL_ADAPTER_ADDRESS, # IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
dwOutBufLen: ptr uint32 # DWORD* in/out
): uint32 {.importc: "GetUniDirectionalAdapterInfo", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint GetUniDirectionalAdapterInfo(
IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* pIPIfInfo, // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
uint* dwOutBufLen // DWORD* in/out
);ccall((:GetUniDirectionalAdapterInfo, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{IP_UNIDIRECTIONAL_ADAPTER_ADDRESS}, Ptr{UInt32}),
pIPIfInfo, dwOutBufLen)
# pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> Ptr{IP_UNIDIRECTIONAL_ADAPTER_ADDRESS}
# dwOutBufLen : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetUniDirectionalAdapterInfo(
void* pIPIfInfo,
uint32_t* dwOutBufLen);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen)
-- pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
-- dwOutBufLen : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetUniDirectionalAdapterInfo = lib.func('__stdcall', 'GetUniDirectionalAdapterInfo', 'uint32_t', ['void *', 'uint32_t *']);
// GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen)
// pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> 'void *'
// dwOutBufLen : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
GetUniDirectionalAdapterInfo: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen)
// pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> "pointer"
// dwOutBufLen : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetUniDirectionalAdapterInfo(
void* pIPIfInfo,
uint32_t* dwOutBufLen);
C, "IPHLPAPI.dll");
// $ffi->GetUniDirectionalAdapterInfo(pIPIfInfo, dwOutBufLen);
// pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
// dwOutBufLen : DWORD* in/out
// 構造体/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 GetUniDirectionalAdapterInfo(
Pointer pIPIfInfo, // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
IntByReference dwOutBufLen // DWORD* in/out
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun GetUniDirectionalAdapterInfo = GetUniDirectionalAdapterInfo(
pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS*, # IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
dwOutBufLen : UInt32* # DWORD* in/out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetUniDirectionalAdapterInfoNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetUniDirectionalAdapterInfoDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetUniDirectionalAdapterInfo = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<GetUniDirectionalAdapterInfoNative, GetUniDirectionalAdapterInfoDart>('GetUniDirectionalAdapterInfo');
// pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> Pointer<Void>
// dwOutBufLen : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetUniDirectionalAdapterInfo(
pIPIfInfo: Pointer; // IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
dwOutBufLen: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetUniDirectionalAdapterInfo';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetUniDirectionalAdapterInfo"
c_GetUniDirectionalAdapterInfo :: Ptr () -> Ptr Word32 -> IO Word32
-- pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> Ptr ()
-- dwOutBufLen : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getunidirectionaladapterinfo =
foreign "GetUniDirectionalAdapterInfo"
((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> (ptr void) *)
(* dwOutBufLen : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("GetUniDirectionalAdapterInfo" get-uni-directional-adapter-info :convention :stdcall) :uint32
(p-ipif-info :pointer) ; IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out
(dw-out-buf-len :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetUniDirectionalAdapterInfo = Win32::API::More->new('IPHLPAPI',
'DWORD GetUniDirectionalAdapterInfo(LPVOID pIPIfInfo, LPVOID dwOutBufLen)');
# my $ret = $GetUniDirectionalAdapterInfo->Call($pIPIfInfo, $dwOutBufLen);
# pIPIfInfo : IP_UNIDIRECTIONAL_ADAPTER_ADDRESS* optional, out -> LPVOID
# dwOutBufLen : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。