Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › GetUdpStatistics

GetUdpStatistics

関数
UDPプロトコルの統計情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetUdpStatistics(
    MIB_UDPSTATS* Stats
);

パラメーター

名前方向説明
StatsMIB_UDPSTATS*outローカルコンピューターの UDP 統計情報を受け取る MIB_UDPSTATS 構造体へのポインターです。

戻り値の型: DWORD

公式ドキュメント

GetUdpStatistics 関数は、ローカルコンピューターの User Datagram Protocol (UDP) 統計情報を取得します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合は、 FormatMessage を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

解説(Remarks)

Windows Server 2003 および Windows XP: IPv6 プロトコルの UDP 統計情報を取得するには、 GetUdpStatisticsEx 関数を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD GetUdpStatistics(
    MIB_UDPSTATS* Stats
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetUdpStatistics(
    IntPtr Stats   // MIB_UDPSTATS* out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetUdpStatistics(
    Stats As IntPtr   ' MIB_UDPSTATS* out
) As UInteger
End Function
' Stats : MIB_UDPSTATS* out
Declare PtrSafe Function GetUdpStatistics Lib "iphlpapi" ( _
    ByVal Stats As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetUdpStatistics = ctypes.windll.iphlpapi.GetUdpStatistics
GetUdpStatistics.restype = wintypes.DWORD
GetUdpStatistics.argtypes = [
    ctypes.c_void_p,  # Stats : MIB_UDPSTATS* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetUdpStatistics = Fiddle::Function.new(
  lib['GetUdpStatistics'],
  [
    Fiddle::TYPE_VOIDP,  # Stats : MIB_UDPSTATS* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetUdpStatistics(
        Stats: *mut MIB_UDPSTATS  // MIB_UDPSTATS* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetUdpStatistics(IntPtr Stats);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetUdpStatistics' -Namespace Win32 -PassThru
# $api::GetUdpStatistics(Stats)
#uselib "IPHLPAPI.dll"
#func global GetUdpStatistics "GetUdpStatistics" sptr
; GetUdpStatistics varptr(Stats)   ; 戻り値は stat
; Stats : MIB_UDPSTATS* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global GetUdpStatistics "GetUdpStatistics" var
; res = GetUdpStatistics(Stats)
; Stats : MIB_UDPSTATS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetUdpStatistics(MIB_UDPSTATS* Stats)
#uselib "IPHLPAPI.dll"
#cfunc global GetUdpStatistics "GetUdpStatistics" var
; res = GetUdpStatistics(Stats)
; Stats : MIB_UDPSTATS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetUdpStatistics = iphlpapi.NewProc("GetUdpStatistics")
)

// Stats (MIB_UDPSTATS* out)
r1, _, err := procGetUdpStatistics.Call(
	uintptr(Stats),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetUdpStatistics(
  Stats: Pointer   // MIB_UDPSTATS* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetUdpStatistics';
result := DllCall("IPHLPAPI\GetUdpStatistics"
    , "Ptr", Stats   ; MIB_UDPSTATS* out
    , "UInt")   ; return: DWORD
●GetUdpStatistics(Stats) = DLL("IPHLPAPI.dll", "dword GetUdpStatistics(void*)")
# 呼び出し: GetUdpStatistics(Stats)
# Stats : MIB_UDPSTATS* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn GetUdpStatistics(
    Stats: [*c]MIB_UDPSTATS // MIB_UDPSTATS* out
) callconv(std.os.windows.WINAPI) u32;
proc GetUdpStatistics(
    Stats: ptr MIB_UDPSTATS  # MIB_UDPSTATS* out
): uint32 {.importc: "GetUdpStatistics", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetUdpStatistics(
    MIB_UDPSTATS* Stats   // MIB_UDPSTATS* out
);
ccall((:GetUdpStatistics, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_UDPSTATS},),
      Stats)
# Stats : MIB_UDPSTATS* out -> Ptr{MIB_UDPSTATS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetUdpStatistics(
    void* Stats);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetUdpStatistics(Stats)
-- Stats : MIB_UDPSTATS* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetUdpStatistics = lib.func('__stdcall', 'GetUdpStatistics', 'uint32_t', ['void *']);
// GetUdpStatistics(Stats)
// Stats : MIB_UDPSTATS* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetUdpStatistics: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetUdpStatistics(Stats)
// Stats : MIB_UDPSTATS* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetUdpStatistics(
    void* Stats);
C, "IPHLPAPI.dll");
// $ffi->GetUdpStatistics(Stats);
// Stats : MIB_UDPSTATS* 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 GetUdpStatistics(
        Pointer Stats   // MIB_UDPSTATS* out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetUdpStatistics = GetUdpStatistics(
    Stats : MIB_UDPSTATS*   # MIB_UDPSTATS* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetUdpStatisticsNative = Uint32 Function(Pointer<Void>);
typedef GetUdpStatisticsDart = int Function(Pointer<Void>);
final GetUdpStatistics = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetUdpStatisticsNative, GetUdpStatisticsDart>('GetUdpStatistics');
// Stats : MIB_UDPSTATS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetUdpStatistics(
  Stats: Pointer   // MIB_UDPSTATS* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetUdpStatistics';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetUdpStatistics"
  c_GetUdpStatistics :: Ptr () -> IO Word32
-- Stats : MIB_UDPSTATS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getudpstatistics =
  foreign "GetUdpStatistics"
    ((ptr void) @-> returning uint32_t)
(* Stats : MIB_UDPSTATS* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetUdpStatistics" get-udp-statistics :convention :stdcall) :uint32
  (stats :pointer))   ; MIB_UDPSTATS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUdpStatistics = Win32::API::More->new('IPHLPAPI',
    'DWORD GetUdpStatistics(LPVOID Stats)');
# my $ret = $GetUdpStatistics->Call($Stats);
# Stats : MIB_UDPSTATS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型