GetModuleFileNameW 函数 (libloaderapi.h)

项目
03/05/2024

检索包含指定模块的文件的完全限定路径。模块必须已由当前进程加载。

若要查找由另一个进程加载的模块的文件，请使用 GetModuleFileNameEx 函数。

语法

DWORD GetModuleFileNameW(
  [in, optional] HMODULE hModule,
  [out]          LPWSTR  lpFilename,
  [in]           DWORD   nSize
);

参数

[in, optional] hModule

正在请求其路径的已加载模块的句柄。如果此参数为 NULL，GetModuleFileName 将检索当前进程的可执行文件的路径。

GetModuleFileName 函数不会检索使用 LOAD_LIBRARY_AS_DATAFILE 标志加载的模块的路径。有关详细信息，请参阅 LoadLibraryEx。

[out] lpFilename

指向接收模块的完全限定路径的缓冲区的指针。如果路径的长度小于 nSize 参数指定的大小，则该函数将成功，并将路径作为以 null 结尾的字符串返回。

如果路径的长度超过 nSize 参数指定的大小，则该函数将成功，字符串将被截断为 nSize 字符，包括终止 null 字符。

Windowsxp： 字符串被截断为 nSize 字符，并且不以 null 结尾。

返回的字符串将使用加载模块时指定的相同格式。因此，路径可以是长文件名或短文件名，并且可以使用前缀“\？”。有关详细信息，请参阅命名文件。

[in] nSize

lpFilename 缓冲区的大小（以 TCHAR 为单位）。

返回值

如果函数成功，则返回值是复制到缓冲区的字符串的长度（以字符为单位），不包括终止 null 字符。如果缓冲区太小而无法保存模块名称，字符串将被截断为 nSize 字符（包括终止 null 字符），函数返回 nSize，函数将最后一个错误设置为 ERROR_INSUFFICIENT_BUFFER。

Windowsxp： 如果缓冲区太小而无法保存模块名称，则函数将返回 nSize ，并且不会修改最后一个错误代码。如果 nSize 为零，则返回值为零，并且不修改最后一个错误代码。

如果函数失败，则返回值为 0（零）。要获得更多的错误信息，请调用 GetLastError。

注解

如果在两个进程中加载 DLL，则一个进程中的文件名可能不同于另一个进程中的文件名。

全局变量 _pgmptr 会自动初始化为可执行文件的完整路径，并可用于检索可执行文件的完整路径名称。

示例

有关示例，请参阅安装服务。

注意

libloaderapi.h 标头将 GetModuleFileName 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。

要求

要求	值
最低受支持的客户端	Windows XP [桌面应用 \| UWP 应用]
最低受支持的服务器	Windows Server 2003 [桌面应用 \| UWP 应用]
目标平台	Windows
标头	libloaderapi.h (包括 Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll