ホーム › NetworkManagement.IpHelper › GetOwnerModuleFromTcpEntry

GetOwnerModuleFromTcpEntry

関数

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

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

シグネチャ

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

DWORD GetOwnerModuleFromTcpEntry(
    MIB_TCPROW_OWNER_MODULE* pTcpEntry,
    TCPIP_OWNER_MODULE_INFO_CLASS Class,
    void* pBuffer,
    DWORD* pdwSize
);

パラメーター

名前

型

方向

説明

pTcpEntry

MIB_TCPROW_OWNER_MODULE*

オーナーモジュールの取得に使用する IPv4 TCP エンドポイントエントリを含む MIB_TCPROW_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 テーブルの行に含まれる特定の IPv4 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_TCPROW_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 以降でアプリケーションにこのマニフェストファイルがない場合、保護対象の pModuleName および pModulePath メンバーへのアクセスを許可するには、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーが、組み込みの 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 GetOwnerModuleFromTcpEntry(
    MIB_TCPROW_OWNER_MODULE* pTcpEntry,
    TCPIP_OWNER_MODULE_INFO_CLASS Class,
    void* pBuffer,
    DWORD* pdwSize
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetOwnerModuleFromTcpEntry(
    IntPtr pTcpEntry,   // MIB_TCPROW_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 GetOwnerModuleFromTcpEntry(
    pTcpEntry As IntPtr,   ' MIB_TCPROW_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_TCPROW_OWNER_MODULE*
' Class : TCPIP_OWNER_MODULE_INFO_CLASS
' pBuffer : void* out
' pdwSize : DWORD* in/out
Declare PtrSafe Function GetOwnerModuleFromTcpEntry 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

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

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