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

GetModuleFileNameW

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

シグネチャ

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

DWORD GetModuleFileNameW(
    HMODULE hModule,   // optional
    LPWSTR lpFilename,
    DWORD nSize
);

パラメーター

名前型方向説明
hModuleHMODULEinoptional

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

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

lpFilenameLPWSTRout

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

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

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

返される文字列は、モジュールが読み込まれたときに指定されたものと同じ形式を使用します。したがって、パスはロングファイル名またはショートファイル名となる場合があり、プレフィックス "\?" を使用する場合もあります。詳細については、 Naming a File を参照してください。

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

Windows XP: バッファーが小さすぎてモジュール名を保持できない場合、関数は nSize を返し、最終エラーコードは変更されません。nSize が 0 の場合、戻り値は 0 となり、最終エラーコードは変更されません。

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

解説(Remarks)

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

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

Examples

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

メモ

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

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

各言語での呼び出し定義

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

DWORD GetModuleFileNameW(
    HMODULE hModule,   // optional
    LPWSTR lpFilename,
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetModuleFileNameW(
    IntPtr hModule,   // HMODULE optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFilename,   // LPWSTR out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetModuleFileNameW(
    hModule As IntPtr,   ' HMODULE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpFilename As System.Text.StringBuilder,   ' LPWSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' hModule : HMODULE optional
' lpFilename : LPWSTR out
' nSize : DWORD
Declare PtrSafe Function GetModuleFileNameW Lib "kernel32" ( _
    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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetModuleFileNameW = kernel32.NewProc("GetModuleFileNameW")
)

// hModule (HMODULE optional), lpFilename (LPWSTR out), nSize (DWORD)
r1, _, err := procGetModuleFileNameW.Call(
	uintptr(hModule),
	uintptr(lpFilename),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetModuleFileNameW(
  hModule: THandle;   // HMODULE optional
  lpFilename: PWideChar;   // LPWSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetModuleFileNameW';
result := DllCall("KERNEL32\GetModuleFileNameW"
    , "Ptr", hModule   ; HMODULE optional
    , "Ptr", lpFilename   ; LPWSTR out
    , "UInt", nSize   ; DWORD
    , "UInt")   ; return: DWORD
●GetModuleFileNameW(hModule, lpFilename, nSize) = DLL("KERNEL32.dll", "dword GetModuleFileNameW(void*, char*, dword)")
# 呼び出し: GetModuleFileNameW(hModule, lpFilename, nSize)
# hModule : HMODULE optional -> "void*"
# lpFilename : LPWSTR out -> "char*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetModuleFileNameW(
    hModule: ?*anyopaque, // HMODULE optional
    lpFilename: [*c]u16, // LPWSTR out
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetModuleFileNameW(
    hModule: pointer,  # HMODULE optional
    lpFilename: ptr uint16,  # LPWSTR out
    nSize: uint32  # DWORD
): uint32 {.importc: "GetModuleFileNameW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetModuleFileNameW(
    void* hModule,   // HMODULE optional
    wchar* lpFilename,   // LPWSTR out
    uint nSize   // DWORD
);
ccall((:GetModuleFileNameW, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt16}, UInt32),
      hModule, lpFilename, nSize)
# hModule : HMODULE optional -> Ptr{Cvoid}
# lpFilename : LPWSTR out -> Ptr{UInt16}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetModuleFileNameW(
    void* hModule,
    uint16_t* lpFilename,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetModuleFileNameW(hModule, lpFilename, nSize)
-- hModule : HMODULE optional
-- lpFilename : LPWSTR out
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetModuleFileNameW = lib.func('__stdcall', 'GetModuleFileNameW', 'uint32_t', ['void *', 'uint16_t *', 'uint32_t']);
// GetModuleFileNameW(hModule, lpFilename, nSize)
// hModule : HMODULE optional -> 'void *'
// lpFilename : LPWSTR out -> 'uint16_t *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetModuleFileNameW: { parameters: ["pointer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetModuleFileNameW(hModule, lpFilename, nSize)
// hModule : HMODULE optional -> "pointer"
// lpFilename : LPWSTR out -> "buffer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetModuleFileNameW(
    void* hModule,
    uint16_t* lpFilename,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->GetModuleFileNameW(hModule, lpFilename, nSize);
// hModule : HMODULE optional
// lpFilename : LPWSTR 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.UNICODE_OPTIONS);
    int GetModuleFileNameW(
        Pointer hModule,   // HMODULE optional
        char[] lpFilename,   // LPWSTR out
        int nSize   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetModuleFileNameW = GetModuleFileNameW(
    hModule : Void*,   # HMODULE optional
    lpFilename : UInt16*,   # LPWSTR 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 GetModuleFileNameWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Uint32);
typedef GetModuleFileNameWDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final GetModuleFileNameW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetModuleFileNameWNative, GetModuleFileNameWDart>('GetModuleFileNameW');
// hModule : HMODULE optional -> Pointer<Void>
// lpFilename : LPWSTR out -> Pointer<Utf16>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetModuleFileNameW(
  hModule: THandle;   // HMODULE optional
  lpFilename: PWideChar;   // LPWSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetModuleFileNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getmodulefilenamew =
  foreign "GetModuleFileNameW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hModule : HMODULE optional -> (ptr void) *)
(* lpFilename : LPWSTR out -> (ptr uint16_t) *)
(* 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 ("GetModuleFileNameW" get-module-file-name-w :convention :stdcall) :uint32
  (h-module :pointer)   ; HMODULE optional
  (lp-filename :pointer)   ; LPWSTR out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetModuleFileNameW = Win32::API::More->new('KERNEL32',
    'DWORD GetModuleFileNameW(HANDLE hModule, LPWSTR lpFilename, DWORD nSize)');
# my $ret = $GetModuleFileNameW->Call($hModule, $lpFilename, $nSize);
# hModule : HMODULE optional -> HANDLE
# lpFilename : LPWSTR out -> LPWSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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