Win32 API 日本語リファレンス
ホーム › System.LibraryLoader › GetModuleFileNameA

GetModuleFileNameA

関数
モジュールの実行ファイルパスをANSI文字列で取得する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD GetModuleFileNameA(
    HMODULE hModule,   // optional
    LPSTR lpFilename,
    DWORD nSize
);

パラメーター

名前型方向説明
hModuleHMODULEinoptional

パスを要求する、読み込み済みモジュールへのハンドル。このパラメーターが NULL の場合、 GetModuleFileName は現在のプロセスの実行可能ファイルのパスを取得します。

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

lpFilenameLPSTRout

モジュールの完全修飾パスを受け取るバッファーへのポインター。パスの長さが nSize パラメーターで指定されたサイズより小さい場合、関数は成功し、パスは null 終端文字列として返されます。

パスの長さが nSize で指定された値以上の場合、関数は成功し、文字列は nSize 文字(終端の null 文字を含む)に切り詰められます。

Windows XP: 文字列は nSize 文字に切り詰められ、null 終端されません。

返される文字列は、モジュールが読み込まれたときに指定されたものと同じ形式を使用します。したがって、パスはロングファイル名またはショートファイル名のいずれかで、接頭辞 \\?\ を使用できます。詳細については、 Naming a File を参照してください。

nSizeDWORDinlpFilename バッファーのサイズ(TCHAR 単位)。

戻り値の型: DWORD

公式ドキュメント

指定されたモジュールを含むファイルの完全修飾パスを取得します。モジュールは現在のプロセスによって読み込まれている必要があります。(ANSI)

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(文字単位、終端の null 文字を含まない)です。バッファーがモジュール名を保持するには小さすぎる場合、文字列は終端の null 文字を含めて nSize 文字に切り詰められ、関数は nSize を返し、最終エラーを ERROR_INSUFFICIENT_BUFFER に設定します。

Windows XP: バッファーがモジュール名を保持するには小さすぎる場合、関数は nSize を返します。最終エラーコードは ERROR_SUCCESS のままです。nSize が 0 の場合、戻り値は 0 で、最終エラーコードは ERROR_SUCCESS です。

関数が失敗した場合、戻り値は 0(ゼロ)です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

DLL が 2 つのプロセスで読み込まれている場合、一方のプロセスでのファイル名は、もう一方のプロセスでのファイル名と大文字小文字が異なる場合があります。

グローバル変数 _pgmptr は実行可能ファイルのフルパスに自動的に初期化され、実行可能ファイルのフルパス名を取得するために使用できます。

例

例については、 Installing a Service を参照してください。

メモ

libloaderapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetModuleFileName を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在して使用すると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、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 GetModuleFileNameA(
    HMODULE hModule,   // optional
    LPSTR lpFilename,
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetModuleFileNameA(
    IntPtr hModule,   // HMODULE optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFilename,   // LPSTR out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetModuleFileNameA(
    hModule As IntPtr,   ' HMODULE optional
    <MarshalAs(UnmanagedType.LPStr)> lpFilename As System.Text.StringBuilder,   ' LPSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' hModule : HMODULE optional
' lpFilename : LPSTR out
' nSize : DWORD
Declare PtrSafe Function GetModuleFileNameA Lib "kernel32" ( _
    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

GetModuleFileNameA = ctypes.windll.kernel32.GetModuleFileNameA
GetModuleFileNameA.restype = wintypes.DWORD
GetModuleFileNameA.argtypes = [
    wintypes.HANDLE,  # hModule : HMODULE optional
    wintypes.LPSTR,  # lpFilename : LPSTR out
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetModuleFileNameA = Fiddle::Function.new(
  lib['GetModuleFileNameA'],
  [
    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 GetModuleFileNameA(
        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, SetLastError = true)]
public static extern uint GetModuleFileNameA(IntPtr hModule, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFilename, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetModuleFileNameA' -Namespace Win32 -PassThru
# $api::GetModuleFileNameA(hModule, lpFilename, nSize)
#uselib "KERNEL32.dll"
#func global GetModuleFileNameA "GetModuleFileNameA" sptr, sptr, sptr
; GetModuleFileNameA hModule, varptr(lpFilename), nSize   ; 戻り値は stat
; hModule : HMODULE optional -> "sptr"
; lpFilename : LPSTR out -> "sptr"
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global GetModuleFileNameA "GetModuleFileNameA" sptr, var, int
; res = GetModuleFileNameA(hModule, lpFilename, nSize)
; hModule : HMODULE optional -> "sptr"
; lpFilename : LPSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD GetModuleFileNameA(HMODULE hModule, LPSTR lpFilename, DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global GetModuleFileNameA "GetModuleFileNameA" intptr, var, int
; res = GetModuleFileNameA(hModule, lpFilename, nSize)
; hModule : HMODULE optional -> "intptr"
; lpFilename : LPSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetModuleFileNameA = kernel32.NewProc("GetModuleFileNameA")
)

// hModule (HMODULE optional), lpFilename (LPSTR out), nSize (DWORD)
r1, _, err := procGetModuleFileNameA.Call(
	uintptr(hModule),
	uintptr(lpFilename),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetModuleFileNameA(
  hModule: THandle;   // HMODULE optional
  lpFilename: PAnsiChar;   // LPSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetModuleFileNameA';
result := DllCall("KERNEL32\GetModuleFileNameA"
    , "Ptr", hModule   ; HMODULE optional
    , "Ptr", lpFilename   ; LPSTR out
    , "UInt", nSize   ; DWORD
    , "UInt")   ; return: DWORD
●GetModuleFileNameA(hModule, lpFilename, nSize) = DLL("KERNEL32.dll", "dword GetModuleFileNameA(void*, char*, dword)")
# 呼び出し: GetModuleFileNameA(hModule, lpFilename, nSize)
# hModule : HMODULE optional -> "void*"
# lpFilename : LPSTR out -> "char*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetModuleFileNameA(
    hModule: ?*anyopaque, // HMODULE optional
    lpFilename: [*c]u8, // LPSTR out
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc GetModuleFileNameA(
    hModule: pointer,  # HMODULE optional
    lpFilename: ptr char,  # LPSTR out
    nSize: uint32  # DWORD
): uint32 {.importc: "GetModuleFileNameA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetModuleFileNameA(
    void* hModule,   // HMODULE optional
    char* lpFilename,   // LPSTR out
    uint nSize   // DWORD
);
ccall((:GetModuleFileNameA, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt8}, UInt32),
      hModule, lpFilename, nSize)
# hModule : HMODULE optional -> Ptr{Cvoid}
# lpFilename : LPSTR out -> Ptr{UInt8}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetModuleFileNameA(
    void* hModule,
    char* lpFilename,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetModuleFileNameA(hModule, lpFilename, nSize)
-- hModule : HMODULE optional
-- lpFilename : LPSTR out
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetModuleFileNameA = lib.func('__stdcall', 'GetModuleFileNameA', 'uint32_t', ['void *', 'char *', 'uint32_t']);
// GetModuleFileNameA(hModule, lpFilename, nSize)
// hModule : HMODULE optional -> 'void *'
// lpFilename : LPSTR out -> 'char *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetModuleFileNameA: { parameters: ["pointer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetModuleFileNameA(hModule, lpFilename, nSize)
// hModule : HMODULE optional -> "pointer"
// lpFilename : LPSTR out -> "buffer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetModuleFileNameA(
    void* hModule,
    char* lpFilename,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->GetModuleFileNameA(hModule, lpFilename, nSize);
// hModule : HMODULE optional
// lpFilename : LPSTR out
// nSize : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    int GetModuleFileNameA(
        Pointer hModule,   // HMODULE optional
        byte[] lpFilename,   // LPSTR out
        int nSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetModuleFileNameA = GetModuleFileNameA(
    hModule : Void*,   # HMODULE optional
    lpFilename : UInt8*,   # LPSTR out
    nSize : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetModuleFileNameANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Uint32);
typedef GetModuleFileNameADart = int Function(Pointer<Void>, Pointer<Utf8>, int);
final GetModuleFileNameA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetModuleFileNameANative, GetModuleFileNameADart>('GetModuleFileNameA');
// hModule : HMODULE optional -> Pointer<Void>
// lpFilename : LPSTR out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetModuleFileNameA(
  hModule: THandle;   // HMODULE optional
  lpFilename: PAnsiChar;   // LPSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetModuleFileNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetModuleFileNameA"
  c_GetModuleFileNameA :: Ptr () -> CString -> Word32 -> IO Word32
-- hModule : HMODULE optional -> Ptr ()
-- lpFilename : LPSTR out -> CString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmodulefilenamea =
  foreign "GetModuleFileNameA"
    ((ptr void) @-> string @-> uint32_t @-> returning uint32_t)
(* hModule : HMODULE optional -> (ptr void) *)
(* lpFilename : LPSTR out -> string *)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetModuleFileNameA" get-module-file-name-a :convention :stdcall) :uint32
  (h-module :pointer)   ; HMODULE optional
  (lp-filename :pointer)   ; LPSTR out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetModuleFileNameA = Win32::API::More->new('KERNEL32',
    'DWORD GetModuleFileNameA(HANDLE hModule, LPSTR lpFilename, DWORD nSize)');
# my $ret = $GetModuleFileNameA->Call($hModule, $lpFilename, $nSize);
# hModule : HMODULE optional -> HANDLE
# lpFilename : LPSTR out -> LPSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目