ホーム › NetworkManagement.IpHelper › GetUdpTable
GetUdpTable
関数現在のUDPエンドポイント一覧をMIB_UDPTABLEとして取得する。
シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD GetUdpTable(
MIB_UDPTABLE* UdpTable, // optional
DWORD* SizePointer,
BOOL Order
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| UdpTable | MIB_UDPTABLE* | outoptional | IPv4 UDP リスナー テーブルを MIB_UDPTABLE 構造体として受け取るバッファーへのポインターです。 |
| SizePointer | DWORD* | inout | 入力時には、UdpTable パラメーターが指すバッファーのサイズをバイト単位で指定します。 出力時には、返されるリスナー テーブルを格納するのにバッファーが十分でない場合、関数はこのパラメーターに必要なバッファー サイズをバイト単位で設定します。 Windows Vista 以降向けにリリースされた Windows SDK では、このパラメーターのデータ型は PDWORD と等価な PULONG に変更されています。 |
| Order | BOOL | in | 返される UDP リスナー テーブルをソートするかどうかを指定するブール値です。このパラメーターが TRUE の場合、テーブルは次の順序でソートされます。
|
戻り値の型: DWORD
公式ドキュメント
IPv4 のユーザー データグラム プロトコル (UDP) リスナー テーブルを取得します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 戻り値 | 説明 |
|---|---|
|
pUdpTable パラメーターが指すバッファーが十分な大きさではありません。必要なサイズは、pdwSize パラメーターが指す ULONG 変数に返されます。
このエラーは、pUdpTable パラメーターが NULL の場合にも返されます。 |
|
| pdwSize パラメーターが NULL であるか、 GetUdpTable が pdwSize パラメーターの指すメモリに書き込めません。 | |
| この関数は、ローカル システムで使用しているオペレーティング システムではサポートされていません。 | |
|
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。 |
解説(Remarks)
Windows Vista 以降向けにリリースされた Windows SDK では、GetUdpTable 関数の戻り値は DWORD と等価な ULONG のデータ型に変更されています。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetUdpTable(
MIB_UDPTABLE* UdpTable, // optional
DWORD* SizePointer,
BOOL Order
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetUdpTable(
IntPtr UdpTable, // MIB_UDPTABLE* optional, out
ref uint SizePointer, // DWORD* in/out
bool Order // BOOL
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetUdpTable(
UdpTable As IntPtr, ' MIB_UDPTABLE* optional, out
ByRef SizePointer As UInteger, ' DWORD* in/out
Order As Boolean ' BOOL
) As UInteger
End Function' UdpTable : MIB_UDPTABLE* optional, out
' SizePointer : DWORD* in/out
' Order : BOOL
Declare PtrSafe Function GetUdpTable Lib "iphlpapi" ( _
ByVal UdpTable As LongPtr, _
ByRef SizePointer As Long, _
ByVal Order As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetUdpTable = ctypes.windll.iphlpapi.GetUdpTable
GetUdpTable.restype = wintypes.DWORD
GetUdpTable.argtypes = [
ctypes.c_void_p, # UdpTable : MIB_UDPTABLE* optional, out
ctypes.POINTER(wintypes.DWORD), # SizePointer : DWORD* in/out
wintypes.BOOL, # Order : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
GetUdpTable = Fiddle::Function.new(
lib['GetUdpTable'],
[
Fiddle::TYPE_VOIDP, # UdpTable : MIB_UDPTABLE* optional, out
Fiddle::TYPE_VOIDP, # SizePointer : DWORD* in/out
Fiddle::TYPE_INT, # Order : BOOL
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn GetUdpTable(
UdpTable: *mut MIB_UDPTABLE, // MIB_UDPTABLE* optional, out
SizePointer: *mut u32, // DWORD* in/out
Order: i32 // BOOL
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetUdpTable(IntPtr UdpTable, ref uint SizePointer, bool Order);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetUdpTable' -Namespace Win32 -PassThru
# $api::GetUdpTable(UdpTable, SizePointer, Order)#uselib "IPHLPAPI.dll"
#func global GetUdpTable "GetUdpTable" sptr, sptr, sptr
; GetUdpTable varptr(UdpTable), varptr(SizePointer), Order ; 戻り値は stat
; UdpTable : MIB_UDPTABLE* optional, out -> "sptr"
; SizePointer : DWORD* in/out -> "sptr"
; Order : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "IPHLPAPI.dll" #cfunc global GetUdpTable "GetUdpTable" var, var, int ; res = GetUdpTable(UdpTable, SizePointer, Order) ; UdpTable : MIB_UDPTABLE* optional, out -> "var" ; SizePointer : DWORD* in/out -> "var" ; Order : BOOL -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global GetUdpTable "GetUdpTable" sptr, sptr, int ; res = GetUdpTable(varptr(UdpTable), varptr(SizePointer), Order) ; UdpTable : MIB_UDPTABLE* optional, out -> "sptr" ; SizePointer : DWORD* in/out -> "sptr" ; Order : BOOL -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD GetUdpTable(MIB_UDPTABLE* UdpTable, DWORD* SizePointer, BOOL Order) #uselib "IPHLPAPI.dll" #cfunc global GetUdpTable "GetUdpTable" var, var, int ; res = GetUdpTable(UdpTable, SizePointer, Order) ; UdpTable : MIB_UDPTABLE* optional, out -> "var" ; SizePointer : DWORD* in/out -> "var" ; Order : BOOL -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetUdpTable(MIB_UDPTABLE* UdpTable, DWORD* SizePointer, BOOL Order) #uselib "IPHLPAPI.dll" #cfunc global GetUdpTable "GetUdpTable" intptr, intptr, int ; res = GetUdpTable(varptr(UdpTable), varptr(SizePointer), Order) ; UdpTable : MIB_UDPTABLE* optional, out -> "intptr" ; SizePointer : DWORD* in/out -> "intptr" ; Order : BOOL -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procGetUdpTable = iphlpapi.NewProc("GetUdpTable")
)
// UdpTable (MIB_UDPTABLE* optional, out), SizePointer (DWORD* in/out), Order (BOOL)
r1, _, err := procGetUdpTable.Call(
uintptr(UdpTable),
uintptr(SizePointer),
uintptr(Order),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetUdpTable(
UdpTable: Pointer; // MIB_UDPTABLE* optional, out
SizePointer: Pointer; // DWORD* in/out
Order: BOOL // BOOL
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetUdpTable';result := DllCall("IPHLPAPI\GetUdpTable"
, "Ptr", UdpTable ; MIB_UDPTABLE* optional, out
, "Ptr", SizePointer ; DWORD* in/out
, "Int", Order ; BOOL
, "UInt") ; return: DWORD●GetUdpTable(UdpTable, SizePointer, Order) = DLL("IPHLPAPI.dll", "dword GetUdpTable(void*, void*, bool)")
# 呼び出し: GetUdpTable(UdpTable, SizePointer, Order)
# UdpTable : MIB_UDPTABLE* optional, out -> "void*"
# SizePointer : DWORD* in/out -> "void*"
# Order : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn GetUdpTable(
UdpTable: [*c]MIB_UDPTABLE, // MIB_UDPTABLE* optional, out
SizePointer: [*c]u32, // DWORD* in/out
Order: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;proc GetUdpTable(
UdpTable: ptr MIB_UDPTABLE, # MIB_UDPTABLE* optional, out
SizePointer: ptr uint32, # DWORD* in/out
Order: int32 # BOOL
): uint32 {.importc: "GetUdpTable", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint GetUdpTable(
MIB_UDPTABLE* UdpTable, // MIB_UDPTABLE* optional, out
uint* SizePointer, // DWORD* in/out
int Order // BOOL
);ccall((:GetUdpTable, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_UDPTABLE}, Ptr{UInt32}, Int32),
UdpTable, SizePointer, Order)
# UdpTable : MIB_UDPTABLE* optional, out -> Ptr{MIB_UDPTABLE}
# SizePointer : DWORD* in/out -> Ptr{UInt32}
# Order : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetUdpTable(
void* UdpTable,
uint32_t* SizePointer,
int32_t Order);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetUdpTable(UdpTable, SizePointer, Order)
-- UdpTable : MIB_UDPTABLE* optional, out
-- SizePointer : DWORD* in/out
-- Order : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetUdpTable = lib.func('__stdcall', 'GetUdpTable', 'uint32_t', ['void *', 'uint32_t *', 'int32_t']);
// GetUdpTable(UdpTable, SizePointer, Order)
// UdpTable : MIB_UDPTABLE* optional, out -> 'void *'
// SizePointer : DWORD* in/out -> 'uint32_t *'
// Order : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
GetUdpTable: { parameters: ["pointer", "pointer", "i32"], result: "u32" },
});
// lib.symbols.GetUdpTable(UdpTable, SizePointer, Order)
// UdpTable : MIB_UDPTABLE* optional, out -> "pointer"
// SizePointer : DWORD* in/out -> "pointer"
// Order : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetUdpTable(
void* UdpTable,
uint32_t* SizePointer,
int32_t Order);
C, "IPHLPAPI.dll");
// $ffi->GetUdpTable(UdpTable, SizePointer, Order);
// UdpTable : MIB_UDPTABLE* optional, out
// SizePointer : DWORD* in/out
// Order : BOOL
// 構造体/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 GetUdpTable(
Pointer UdpTable, // MIB_UDPTABLE* optional, out
IntByReference SizePointer, // DWORD* in/out
boolean Order // BOOL
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun GetUdpTable = GetUdpTable(
UdpTable : MIB_UDPTABLE*, # MIB_UDPTABLE* optional, out
SizePointer : UInt32*, # DWORD* in/out
Order : Int32 # BOOL
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetUdpTableNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Int32);
typedef GetUdpTableDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final GetUdpTable = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<GetUdpTableNative, GetUdpTableDart>('GetUdpTable');
// UdpTable : MIB_UDPTABLE* optional, out -> Pointer<Void>
// SizePointer : DWORD* in/out -> Pointer<Uint32>
// Order : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetUdpTable(
UdpTable: Pointer; // MIB_UDPTABLE* optional, out
SizePointer: Pointer; // DWORD* in/out
Order: BOOL // BOOL
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetUdpTable';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetUdpTable"
c_GetUdpTable :: Ptr () -> Ptr Word32 -> CInt -> IO Word32
-- UdpTable : MIB_UDPTABLE* optional, out -> Ptr ()
-- SizePointer : DWORD* in/out -> Ptr Word32
-- Order : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getudptable =
foreign "GetUdpTable"
((ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning uint32_t)
(* UdpTable : MIB_UDPTABLE* optional, out -> (ptr void) *)
(* SizePointer : DWORD* in/out -> (ptr uint32_t) *)
(* Order : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("GetUdpTable" get-udp-table :convention :stdcall) :uint32
(udp-table :pointer) ; MIB_UDPTABLE* optional, out
(size-pointer :pointer) ; DWORD* in/out
(order :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetUdpTable = Win32::API::More->new('IPHLPAPI',
'DWORD GetUdpTable(LPVOID UdpTable, LPVOID SizePointer, BOOL Order)');
# my $ret = $GetUdpTable->Call($UdpTable, $SizePointer, $Order);
# UdpTable : MIB_UDPTABLE* optional, out -> LPVOID
# SizePointer : DWORD* in/out -> LPVOID
# Order : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f GetExtendedUdpTable — 所有プロセスID等を含む拡張UDPエンドポイントテーブルを取得する。
- f GetOwnerModuleFromUdp6Entry — 指定IPv6 UDPエンドポイントを所有するプロセスのモジュール情報を取得する。
- f GetOwnerModuleFromUdpEntry — 指定UDPエンドポイントを所有するプロセスのモジュール情報を取得する。
- f GetUdp6Table — 現在のIPv6 UDPエンドポイント一覧を取得する。
- f GetUdpStatistics — UDPプロトコルの統計情報を取得する。
- f GetUdpStatisticsEx — 指定アドレスファミリのUDPプロトコル統計情報を取得する。
- s MIB_UDPROW
- s MIB_UDPROW_OWNER_MODULE
- s MIB_UDPROW_OWNER_PID
- s MIB_UDPTABLE_OWNER_MODULE
- s MIB_UDPTABLE_OWNER_PID
使用する型