ホーム › NetworkManagement.IpHelper › GetOwnerModuleFromUdp6Entry

GetOwnerModuleFromUdp6Entry

関数

指定IPv6 UDPエンドポイントを所有するプロセスのモジュール情報を取得する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD GetOwnerModuleFromUdp6Entry(
    MIB_UDP6ROW_OWNER_MODULE* pUdpEntry,
    TCPIP_OWNER_MODULE_INFO_CLASS Class,
    void* pBuffer,
    DWORD* pdwSize
);

パラメーター

名前

型

方向

説明

pUdpEntry

MIB_UDP6ROW_OWNER_MODULE*

所有者モジュールを取得するために使用する IPv6 UDP エンドポイントエントリを格納した MIB_UDP6ROW_OWNER_MODULE 構造体へのポインターです。

Class

TCPIP_OWNER_MODULE_INFO_CLASS

所有者モジュールについて取得するデータの種類を示す TCPIP_OWNER_MODULE_INFO_CLASS 列挙値です。

pBuffer

void*

out

所有者モジュールのデータを含む TCPIP_OWNER_MODULE_BASIC_INFO 構造体を格納するバッファーです。このバッファーに返されるデータの種類は Class パラメーターの値によって示されます。

Class が対応する値に設定されている場合、Buffer 内のデータには次の構造体が使用されます。

Class 列挙値	Buffer のデータ形式
TCPIP_OWNER_MODULE_BASIC_INFO	TCPIP_OWNER_MODULE_BASIC_INFO

pdwSize

DWORD*

inout

Buffer に返される構造体の推定サイズ (バイト単位) です。この値が小さすぎる場合、この関数は ERROR_INSUFFICIENT_BUFFER を返し、このフィールドには構造体の正しいサイズが格納されます。

戻り値の型: DWORD

公式ドキュメント

MIB テーブルの行内にある特定の IPv6 UDP エンドポイントに対して、コンテキストバインドを発行したモジュールに関するデータを取得します。

戻り値

呼び出しが成功した場合は、NO_ERROR が返されます。それ以外の場合は、次のエラーが返されます。

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	テーブルに割り当てられた領域が不足しています。テーブルのサイズは pdwSize パラメーターに返されます。テーブルを正常に取得するには、その値をこの関数への後続の呼び出しで使用する必要があります。

解説(Remarks)

Buffer パラメーターには、特定のデータへのポインター (たとえば、所有者モジュールの名前とパスを含む NULL 終端文字列へのポインター) を持つ構造体だけでなく、実際のデータそのもの (つまり名前とパスの文字列) も含まれます。したがって、バッファーサイズを計算する際は、構造体と、その構造体のメンバーが指すデータの両方を格納できる十分な領域を確保してください。

UDP テーブルエントリを所有者モジュールに解決することはベストエフォートで行われます。一部のケースでは、TCPIP_OWNER_MODULE_BASIC_INFO 構造体に返される所有者モジュール名が、"svchost.exe" のようなプロセス名、"RPC" のようなサービス名、または "timer.dll" のようなコンポーネント名になることがあります。

Windows Vista 以降を実行しているコンピューターでは、TCPIP_OWNER_MODULE_BASIC_INFO 構造体の pModuleName および pModulePath メンバーへのアクセスは、ユーザーアカウント制御 (UAC) によって制限されます。この関数を呼び出すアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、この呼び出しは成功しますが、アプリケーションのマニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、これらのメンバーへのアクセスは空の文字列を返します。Windows Vista 以降でアプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーが、保護された pModuleName および pModulePath メンバーへのアクセスを許可されるには、組み込みの Administrator として昇格されたシェル (管理者として実行) でアプリケーションを実行する必要があります。

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

各言語での呼び出し定義

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

DWORD GetOwnerModuleFromUdp6Entry(
    MIB_UDP6ROW_OWNER_MODULE* pUdpEntry,
    TCPIP_OWNER_MODULE_INFO_CLASS Class,
    void* pBuffer,
    DWORD* pdwSize
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetOwnerModuleFromUdp6Entry(
    IntPtr pUdpEntry,   // MIB_UDP6ROW_OWNER_MODULE*
    int Class,   // TCPIP_OWNER_MODULE_INFO_CLASS
    IntPtr pBuffer,   // void* out
    ref uint pdwSize   // DWORD* in/out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetOwnerModuleFromUdp6Entry(
    pUdpEntry As IntPtr,   ' MIB_UDP6ROW_OWNER_MODULE*
    Class As Integer,   ' TCPIP_OWNER_MODULE_INFO_CLASS
    pBuffer As IntPtr,   ' void* out
    ByRef pdwSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' pUdpEntry : MIB_UDP6ROW_OWNER_MODULE*
' Class : TCPIP_OWNER_MODULE_INFO_CLASS
' pBuffer : void* out
' pdwSize : DWORD* in/out
Declare PtrSafe Function GetOwnerModuleFromUdp6Entry Lib "iphlpapi" ( _
    ByVal pUdpEntry As LongPtr, _
    ByVal Class As Long, _
    ByVal pBuffer As LongPtr, _
    ByRef pdwSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetOwnerModuleFromUdp6Entry = ctypes.windll.iphlpapi.GetOwnerModuleFromUdp6Entry
GetOwnerModuleFromUdp6Entry.restype = wintypes.DWORD
GetOwnerModuleFromUdp6Entry.argtypes = [
    ctypes.c_void_p,  # pUdpEntry : MIB_UDP6ROW_OWNER_MODULE*
    ctypes.c_int,  # Class : TCPIP_OWNER_MODULE_INFO_CLASS
    ctypes.POINTER(None),  # pBuffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # pdwSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetOwnerModuleFromUdp6Entry = Fiddle::Function.new(
  lib['GetOwnerModuleFromUdp6Entry'],
  [
    Fiddle::TYPE_VOIDP,  # pUdpEntry : MIB_UDP6ROW_OWNER_MODULE*
    Fiddle::TYPE_INT,  # Class : TCPIP_OWNER_MODULE_INFO_CLASS
    Fiddle::TYPE_VOIDP,  # pBuffer : void* out
    Fiddle::TYPE_VOIDP,  # pdwSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetOwnerModuleFromUdp6Entry(
        pUdpEntry: *mut MIB_UDP6ROW_OWNER_MODULE,  // MIB_UDP6ROW_OWNER_MODULE*
        Class: i32,  // TCPIP_OWNER_MODULE_INFO_CLASS
        pBuffer: *mut (),  // void* out
        pdwSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetOwnerModuleFromUdp6Entry(IntPtr pUdpEntry, int Class, IntPtr pBuffer, ref uint pdwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetOwnerModuleFromUdp6Entry' -Namespace Win32 -PassThru
# $api::GetOwnerModuleFromUdp6Entry(pUdpEntry, Class, pBuffer, pdwSize)

#uselib "IPHLPAPI.dll"
#func global GetOwnerModuleFromUdp6Entry "GetOwnerModuleFromUdp6Entry" sptr, sptr, sptr, sptr
; GetOwnerModuleFromUdp6Entry varptr(pUdpEntry), Class, pBuffer, varptr(pdwSize)   ; 戻り値は stat
; pUdpEntry : MIB_UDP6ROW_OWNER_MODULE* -> "sptr"
; Class : TCPIP_OWNER_MODULE_INFO_CLASS -> "sptr"
; pBuffer : void* out -> "sptr"
; pdwSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global GetOwnerModuleFromUdp6Entry "GetOwnerModuleFromUdp6Entry" var, int, sptr, var
; res = GetOwnerModuleFromUdp6Entry(pUdpEntry, Class, pBuffer, pdwSize)
; pUdpEntry : MIB_UDP6ROW_OWNER_MODULE* -> "var"
; Class : TCPIP_OWNER_MODULE_INFO_CLASS -> "int"
; pBuffer : void* out -> "sptr"
; pdwSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global GetOwnerModuleFromUdp6Entry "GetOwnerModuleFromUdp6Entry" sptr, int, sptr, sptr
; res = GetOwnerModuleFromUdp6Entry(varptr(pUdpEntry), Class, pBuffer, varptr(pdwSize))
; pUdpEntry : MIB_UDP6ROW_OWNER_MODULE* -> "sptr"
; Class : TCPIP_OWNER_MODULE_INFO_CLASS -> "int"
; pBuffer : void* out -> "sptr"
; pdwSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。