ホーム › System.ProcessStatus › K32GetModuleFileNameExA

K32GetModuleFileNameExA

関数

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

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD K32GetModuleFileNameExA(
    HANDLE hProcess,   // optional
    HMODULE hModule,   // optional
    LPSTR 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	LPSTR	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 を読み込みます。

例

例については、 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)

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD K32GetModuleFileNameExA(
    HANDLE hProcess,   // optional
    HMODULE hModule,   // optional
    LPSTR lpFilename,
    DWORD nSize
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint K32GetModuleFileNameExA(
    IntPtr hProcess,   // HANDLE optional
    IntPtr hModule,   // HMODULE optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFilename,   // LPSTR out
    uint nSize   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function K32GetModuleFileNameExA(
    hProcess As IntPtr,   ' HANDLE optional
    hModule As IntPtr,   ' HMODULE optional
    <MarshalAs(UnmanagedType.LPStr)> lpFilename As System.Text.StringBuilder,   ' LPSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function

' hProcess : HANDLE optional
' hModule : HMODULE optional
' lpFilename : LPSTR out
' nSize : DWORD
Declare PtrSafe Function K32GetModuleFileNameExA Lib "kernel32" ( _
    ByVal hProcess As LongPtr, _
    ByVal hModule As LongPtr, _
    ByVal lpFilename As String, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

K32GetModuleFileNameExA = ctypes.windll.kernel32.K32GetModuleFileNameExA
K32GetModuleFileNameExA.restype = wintypes.DWORD
K32GetModuleFileNameExA.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE optional
    wintypes.HANDLE,  # hModule : HMODULE optional
    wintypes.LPSTR,  # lpFilename : LPSTR out
    wintypes.DWORD,  # nSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
K32GetModuleFileNameExA = Fiddle::Function.new(
  lib['K32GetModuleFileNameExA'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE optional
    Fiddle::TYPE_VOIDP,  # hModule : HMODULE optional
    Fiddle::TYPE_VOIDP,  # lpFilename : LPSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern uint K32GetModuleFileNameExA(IntPtr hProcess, IntPtr hModule, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFilename, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_K32GetModuleFileNameExA' -Namespace Win32 -PassThru
# $api::K32GetModuleFileNameExA(hProcess, hModule, lpFilename, nSize)

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

出力引数:

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