ホーム › System.ProcessStatus › GetModuleBaseNameW

GetModuleBaseNameW

関数

指定モジュールの基本名をUnicode文字列で取得する。

DLLPSAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// PSAPI.dll  (Unicode / -W)
#include <windows.h>

DWORD GetModuleBaseNameW(
    HANDLE hProcess,
    HMODULE hModule,   // optional
    LPWSTR lpBaseName,
    DWORD nSize
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	モジュールを含むプロセスへのハンドル。このハンドルには PROCESS_QUERY_INFORMATION および PROCESS_VM_READ アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。
hModule	HMODULE	inoptional	モジュールへのハンドル。このパラメーターが NULL の場合、この関数は呼び出し元プロセスの作成に使用されたファイルの名前を返します。
lpBaseName	LPWSTR	out	モジュールのベース名を受け取るバッファーへのポインター。ベース名が nSize パラメーターで指定した最大文字数より長い場合、ベース名は切り捨てられます。
nSize	DWORD	in	lpBaseName バッファーのサイズ(文字数単位)。

戻り値の型: DWORD

公式ドキュメント

指定したモジュールのベース名を取得します。(Unicode)

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(文字数単位)を表します。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

GetModuleBaseName 関数は、主にデバッガーや、別のプロセスからモジュール情報を抽出する必要がある同様のアプリケーションでの使用を想定して設計されています。対象プロセスのモジュールリストが破損している場合、まだ初期化されていない場合、または DLL の読み込みやアンロードによって関数呼び出しの最中にモジュールリストが変化する場合、GetModuleBaseName は失敗するか、誤った情報を返すことがあります。

現在のプロセス内のモジュールのベース名を取得するには、GetModuleFileName 関数を使用して完全なモジュール名を取得し、strrchr(szmodulename, '\') のような関数呼び出しを使用してモジュール名文字列内のベース名の先頭まで走査します。これは、現在のプロセスのハンドルを指定して GetModuleBaseName を呼び出すよりも効率的かつ確実です。

リモートプロセスのメイン実行可能モジュールのベース名を取得するには、GetProcessImageFileName 関数または QueryFullProcessImageName 関数を使用してモジュール名を取得し、前の段落で説明したように strrchr 関数を使用します。これは、NULL のモジュールハンドルを指定して GetModuleBaseName を呼び出すよりも効率的かつ確実です。

GetModuleBaseName 関数は、LOAD_LIBRARY_AS_DATAFILE フラグで読み込まれたモジュールのベース名は取得しません。詳細については、LoadLibraryEx を参照してください。

Windows 7 および Windows Server 2008 R2 以降、Psapi.h は PSAPI 関数のバージョン番号を定義します。PSAPI バージョン番号は、関数の呼び出しに使用される名前と、プログラムが読み込む必要のあるライブラリに影響します。

PSAPI_VERSION が 2 以上の場合、この関数は Psapi.h で K32GetModuleBaseName として定義され、Kernel32.lib および Kernel32.dll でエクスポートされます。PSAPI_VERSION が 1 の場合、この関数は Psapi.h で GetModuleBaseName として定義され、K32GetModuleBaseName を呼び出すラッパーとして Psapi.lib および Psapi.dll でエクスポートされます。

Windows 7 以降のバージョンに加えて、それより前のバージョンの Windows でも実行する必要があるプログラムは、常にこの関数を GetModuleBaseName として呼び出す必要があります。シンボルが正しく解決されるようにするには、TARGETLIBS マクロに Psapi.lib を追加し、-DPSAPI_VERSION=1 を指定してプログラムをコンパイルします。実行時動的リンクを使用するには、Psapi.dll を読み込みます。

例

例については、Enumerating All Processes を参照してください。

メモ

psapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetModuleBaseName を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立ではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// PSAPI.dll  (Unicode / -W)
#include <windows.h>

DWORD GetModuleBaseNameW(
    HANDLE hProcess,
    HMODULE hModule,   // optional
    LPWSTR lpBaseName,
    DWORD nSize
);

[DllImport("PSAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetModuleBaseNameW(
    IntPtr hProcess,   // HANDLE
    IntPtr hModule,   // HMODULE optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBaseName,   // LPWSTR out
    uint nSize   // DWORD
);

<DllImport("PSAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetModuleBaseNameW(
    hProcess As IntPtr,   ' HANDLE
    hModule As IntPtr,   ' HMODULE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpBaseName As System.Text.StringBuilder,   ' LPWSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function

' hProcess : HANDLE
' hModule : HMODULE optional
' lpBaseName : LPWSTR out
' nSize : DWORD
Declare PtrSafe Function GetModuleBaseNameW Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal hModule As LongPtr, _
    ByVal lpBaseName As LongPtr, _
    ByVal nSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetModuleBaseNameW = ctypes.windll.psapi.GetModuleBaseNameW
GetModuleBaseNameW.restype = wintypes.DWORD
GetModuleBaseNameW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.HANDLE,  # hModule : HMODULE optional
    wintypes.LPWSTR,  # lpBaseName : LPWSTR out
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PSAPI.dll')
GetModuleBaseNameW = Fiddle::Function.new(
  lib['GetModuleBaseNameW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # hModule : HMODULE optional
    Fiddle::TYPE_VOIDP,  # lpBaseName : LPWSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "psapi")]
extern "system" {
    fn GetModuleBaseNameW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        hModule: *mut core::ffi::c_void,  // HMODULE optional
        lpBaseName: *mut u16,  // LPWSTR out
        nSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PSAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetModuleBaseNameW(IntPtr hProcess, IntPtr hModule, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBaseName, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetModuleBaseNameW' -Namespace Win32 -PassThru
# $api::GetModuleBaseNameW(hProcess, hModule, lpBaseName, nSize)

#uselib "PSAPI.dll"
#func global GetModuleBaseNameW "GetModuleBaseNameW" wptr, wptr, wptr, wptr
; GetModuleBaseNameW hProcess, hModule, varptr(lpBaseName), nSize   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; hModule : HMODULE optional -> "wptr"
; lpBaseName : LPWSTR out -> "wptr"
; nSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "PSAPI.dll"
#cfunc global GetModuleBaseNameW "GetModuleBaseNameW" sptr, sptr, var, int
; res = GetModuleBaseNameW(hProcess, hModule, lpBaseName, nSize)
; hProcess : HANDLE -> "sptr"
; hModule : HMODULE optional -> "sptr"
; lpBaseName : LPWSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "PSAPI.dll"
#cfunc global GetModuleBaseNameW "GetModuleBaseNameW" sptr, sptr, sptr, int
; res = GetModuleBaseNameW(hProcess, hModule, varptr(lpBaseName), nSize)
; hProcess : HANDLE -> "sptr"
; hModule : HMODULE optional -> "sptr"
; lpBaseName : LPWSTR out -> "sptr"
; nSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。