ホーム › System.ProcessStatus › GetModuleFileNameExW

GetModuleFileNameExW

関数

指定モジュールの完全パスをUnicode文字列で取得する。

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

シグネチャ

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

DWORD GetModuleFileNameExW(
    HANDLE hProcess,   // optional
    HMODULE hModule,   // optional
    LPWSTR lpFilename,
    DWORD nSize
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	inoptional	モジュールを含むプロセスへのハンドル。このハンドルには PROCESS_QUERY_INFORMATION および PROCESS_VM_READ アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。 Windows 10 以降、Windows Server 2016 以降: hModule パラメーターが NULL の場合、ハンドルには PROCESS_QUERY_LIMITED_INFORMATION アクセス権のみが必要です。 GetModuleFileNameEx 関数は、LOAD_LIBRARY_AS_DATAFILE フラグを使用して読み込まれたモジュールのパスは取得しません。詳細については、LoadLibraryEx を参照してください。
hModule	HMODULE	inoptional	モジュールへのハンドル。このパラメーターが NULL の場合、GetModuleFileNameEx は hProcess で指定されたプロセスの実行可能ファイルのパスを返します。
lpFilename	LPWSTR	out	モジュールへの完全修飾パスを受け取るバッファーへのポインター。ファイル名のサイズが nSize パラメーターの値より大きい場合、関数は成功しますが、ファイル名は切り詰められ、null 終端されます。
nSize	DWORD	in	lpFilename バッファーのサイズ(文字数単位)。

戻り値の型: DWORD

公式ドキュメント

指定したモジュールを含むファイルの完全修飾パスを取得します。(Unicode)

戻り値

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

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

解説(Remarks)

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

現在のプロセス内のモジュール名を取得するには、GetModuleFileName 関数を使用してください。これは、現在のプロセスのハンドルを指定して GetModuleFileNameEx を呼び出すよりも効率的で信頼性が高い方法です。

リモートプロセスのメイン実行可能モジュールの名前を取得するには、GetProcessImageFileName 関数または QueryFullProcessImageName 関数を使用してください。これは、NULL のモジュールハンドルを指定して GetModuleFileNameEx 関数を呼び出すよりも効率的で信頼性が高い方法です。

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

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

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

Examples

例については、 Enumerating All Modules for a Process を参照してください。

メモ

psapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetModuleFileNameEx を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 GetModuleFileNameExW(
    HANDLE hProcess,   // optional
    HMODULE hModule,   // optional
    LPWSTR lpFilename,
    DWORD nSize
);

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

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

' hProcess : HANDLE optional
' hModule : HMODULE optional
' lpFilename : LPWSTR out
' nSize : DWORD
Declare PtrSafe Function GetModuleFileNameExW Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal hModule As LongPtr, _
    ByVal lpFilename 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

GetModuleFileNameExW = ctypes.windll.psapi.GetModuleFileNameExW
GetModuleFileNameExW.restype = wintypes.DWORD
GetModuleFileNameExW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE optional
    wintypes.HANDLE,  # hModule : HMODULE optional
    wintypes.LPWSTR,  # lpFilename : 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')
GetModuleFileNameExW = Fiddle::Function.new(
  lib['GetModuleFileNameExW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE optional
    Fiddle::TYPE_VOIDP,  # hModule : HMODULE optional
    Fiddle::TYPE_VOIDP,  # lpFilename : 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 GetModuleFileNameExW(
        hProcess: *mut core::ffi::c_void,  // HANDLE optional
        hModule: *mut core::ffi::c_void,  // HMODULE optional
        lpFilename: *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 GetModuleFileNameExW(IntPtr hProcess, IntPtr hModule, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFilename, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetModuleFileNameExW' -Namespace Win32 -PassThru
# $api::GetModuleFileNameExW(hProcess, hModule, lpFilename, nSize)

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

出力引数:

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