ホーム › NetworkManagement.IpHelper › GetOwnerModuleFromTcp6Entry

GetOwnerModuleFromTcp6Entry

関数

指定IPv6 TCP接続を所有するプロセスのモジュール情報を取得する。

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

シグネチャ

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

DWORD GetOwnerModuleFromTcp6Entry(
    MIB_TCP6ROW_OWNER_MODULE* pTcpEntry,
    TCPIP_OWNER_MODULE_INFO_CLASS Class,
    void* pBuffer,
    DWORD* pdwSize
);

パラメーター

名前

型

方向

説明

pTcpEntry

MIB_TCP6ROW_OWNER_MODULE*

オーナーモジュールの取得に使用する IPv6 TCP エンドポイントエントリを格納した MIB_TCP6ROW_OWNER_MODULE 構造体へのポインターです。

Class

TCPIP_OWNER_MODULE_INFO_CLASS

オーナーモジュールについて取得するデータの種類を示す TCPIP_OWNER_MODULE_INFO_CLASS 列挙値です。TCPIP_OWNER_MODULE_INFO_CLASS 列挙体は Iprtrmib.h ヘッダーファイルで定義されています。

このパラメーターには TCPIP_OWNER_MODULE_INFO_BASIC を設定する必要があります。

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 TCP エンドポイントに対してコンテキストバインドを発行したモジュールに関するデータを取得します。

戻り値

関数の呼び出しが成功した場合、値 NO_ERROR が返されます。

関数が失敗した場合、戻り値は次のエラーコードのいずれかになります。

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	テーブルに割り当てられた領域が不足しています。テーブルのサイズは pdwSize パラメーターに返され、テーブルを正しく取得するにはこのサイズを後続のこの関数の呼び出しで使用する必要があります。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。この値は、pTcpEntry または pdwSize パラメーターのいずれかが NULL の場合に返されます。また、Class パラメーターが TCPIP_OWNER_MODULE_INFO_BASIC と等しくない場合にも返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なメモリがありません。
ERROR_NOT_FOUND	要素が見つかりませんでした。この値は、pTcpEntry パラメーターが指す MIB_TCP6ROW_OWNER_MODULE の dwOwningPid メンバーが 0 であるか、見つからなかった場合に返されます。
ERROR_PARTIAL_COPY	要求の一部のみが完了しました。

解説(Remarks)

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

TCP テーブルエントリのオーナーモジュールへの解決はベストエフォートで行われます。少数のケースでは、TCPIP_OWNER_MODULE_BASIC_INFO 構造体に返されるオーナーモジュール名が、プロセス名("svchost.exe" など)、サービス名("RPC" など)、またはコンポーネント名("timer.dll" など)になることがあります。

Windows Vista 以降が動作するコンピューターでは、GetOwnerModuleFromTcpEntry 関数によって取得される TCPIP_OWNER_MODULE_BASIC_INFO の pModuleName および pModulePath メンバーが、一部の TCP 接続では空の文字列を指す場合があります。Windows システムフォルダー(既定では C:\Windows\System32)にある TCP 接続を開始するアプリケーションは保護されているとみなされます。GetOwnerModuleFromTcpEntry 関数が Administrators グループのメンバーでないユーザーによって呼び出された場合、関数の呼び出しは成功しますが、保護されたアプリケーションによって開始された TCP 接続については、pModuleName および pModulePath メンバーは空の文字列を格納するメモリを指します。

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 GetOwnerModuleFromTcp6Entry(
    MIB_TCP6ROW_OWNER_MODULE* pTcpEntry,
    TCPIP_OWNER_MODULE_INFO_CLASS Class,
    void* pBuffer,
    DWORD* pdwSize
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetOwnerModuleFromTcp6Entry(
    IntPtr pTcpEntry,   // MIB_TCP6ROW_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 GetOwnerModuleFromTcp6Entry(
    pTcpEntry As IntPtr,   ' MIB_TCP6ROW_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

' pTcpEntry : MIB_TCP6ROW_OWNER_MODULE*
' Class : TCPIP_OWNER_MODULE_INFO_CLASS
' pBuffer : void* out
' pdwSize : DWORD* in/out
Declare PtrSafe Function GetOwnerModuleFromTcp6Entry Lib "iphlpapi" ( _
    ByVal pTcpEntry 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

GetOwnerModuleFromTcp6Entry = ctypes.windll.iphlpapi.GetOwnerModuleFromTcp6Entry
GetOwnerModuleFromTcp6Entry.restype = wintypes.DWORD
GetOwnerModuleFromTcp6Entry.argtypes = [
    ctypes.c_void_p,  # pTcpEntry : MIB_TCP6ROW_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')
GetOwnerModuleFromTcp6Entry = Fiddle::Function.new(
  lib['GetOwnerModuleFromTcp6Entry'],
  [
    Fiddle::TYPE_VOIDP,  # pTcpEntry : MIB_TCP6ROW_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 GetOwnerModuleFromTcp6Entry(
        pTcpEntry: *mut MIB_TCP6ROW_OWNER_MODULE,  // MIB_TCP6ROW_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 GetOwnerModuleFromTcp6Entry(IntPtr pTcpEntry, int Class, IntPtr pBuffer, ref uint pdwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetOwnerModuleFromTcp6Entry' -Namespace Win32 -PassThru
# $api::GetOwnerModuleFromTcp6Entry(pTcpEntry, Class, pBuffer, pdwSize)

#uselib "IPHLPAPI.dll"
#func global GetOwnerModuleFromTcp6Entry "GetOwnerModuleFromTcp6Entry" sptr, sptr, sptr, sptr
; GetOwnerModuleFromTcp6Entry varptr(pTcpEntry), Class, pBuffer, varptr(pdwSize)   ; 戻り値は stat
; pTcpEntry : MIB_TCP6ROW_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 GetOwnerModuleFromTcp6Entry "GetOwnerModuleFromTcp6Entry" var, int, sptr, var
; res = GetOwnerModuleFromTcp6Entry(pTcpEntry, Class, pBuffer, pdwSize)
; pTcpEntry : MIB_TCP6ROW_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 GetOwnerModuleFromTcp6Entry "GetOwnerModuleFromTcp6Entry" sptr, int, sptr, sptr
; res = GetOwnerModuleFromTcp6Entry(varptr(pTcpEntry), Class, pBuffer, varptr(pdwSize))
; pTcpEntry : MIB_TCP6ROW_OWNER_MODULE* -> "sptr"
; Class : TCPIP_OWNER_MODULE_INFO_CLASS -> "int"
; pBuffer : void* out -> "sptr"
; pdwSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。