GetFullPathNameW 函数（fileapi.h）

项目
11/20/2024

检索指定文件的完整路径和文件名。

若要将此操作作为事务处理操作执行，请使用 GetFullPathNameTransacted 函数。

有关文件和路径名称的详细信息，请参阅文件名、路径和命名空间。

注释请参阅“备注”部分，了解如何在多线程应用程序或共享库代码中使用具有 GetFullPathName 函数的相对路径。

语法

DWORD GetFullPathNameW(
  [in]  LPCWSTR lpFileName,
  [in]  DWORD   nBufferLength,
  [out] LPWSTR  lpBuffer,
  [out] LPWSTR  *lpFilePart
);

参数

[in] lpFileName

文件的名称。

此参数可以是短（8.3 窗体）或长文件名。此字符串也可以是共享或卷名称。

默认情况下，名称限制为MAX_PATH个字符。若要将此限制扩展到 32,767 宽字符，请将“\\？\”前面追加到路径。有关详细信息，请参阅命名文件、路径和命名空间。

提示

从 Windows 10 版本 1607 开始，你可以选择加入以删除MAX_PATH限制，而无需追加“\\？\”。有关详细信息，请参阅命名文件、路径和命名空间的“最大路径长度限制”部分。

[in] nBufferLength

要接收驱动器和路径的以 null 结尾的字符串的缓冲区的大小，TCHAR。

[out] lpBuffer

指向接收驱动器和路径的 null 终止字符串的缓冲区的指针。

[out] lpFilePart

指向接收路径中最终文件名组件的地址（lpBuffer）的缓冲区的指针。

此参数可以 NULL。

如果 lpBuffer 引用目录而不是文件，lpFilePart 接收零。

返回值

如果函数成功，则返回值为复制到 lpBuffer的字符串的长度（TCHAr，不包括终止 null 字符）。

如果 lpBuffer 缓冲区太小而无法包含路径，则返回值为大小（TCHAR）是保存路径和终止 null 字符所需的缓冲区的大小。

如果函数因任何其他原因而失败，则返回值为零。若要获取扩展的错误信息，请调用 GetLastError。

言论

GetFullPathName 将当前驱动器和目录的名称与指定的文件名合并，以确定指定文件的完整路径和文件名。它还计算完整路径和文件名的文件名部分的地址。

此函数不验证生成的路径和文件名是否有效，或者它们是否在关联的卷上看到现有文件。

请注意，lpFilePart 参数不需要字符串缓冲区空间，而只需要一个地址。这是因为它只返回已存在用于 lpBuffer的缓冲区中的地址。

共享和卷名称是 lpFileName的有效输入。例如，如果 test-2 是远程计算机，则以下列表标识返回的路径和文件名：是网络映射驱动器，其当前目录是卷的根目录：

如果指定“\\test-2\q$\lh”，则返回的路径为“\\test-2\q$\lh”
如果指定“\\？\UNC\test-2\q$\lh”，则返回的路径为“\\？\UNC\test-2\q$\lh”
如果指定“U：”，则返回的路径是“U：\”驱动器上的当前目录

GetFullPathName 不转换指定的文件名，lpFileName。如果指定的文件名存在，可以使用 GetLongPathName 或 GetShortPathName 分别转换为长路径名称或短路径名称。

如果返回值大于或等于 nBufferLength中指定的值，则可以使用足够大的缓冲区再次调用该函数，以容纳路径。有关此示例的示例，除了使用零长度缓冲区进行动态分配，请参阅“示例代码”部分。

注意虽然本例中的返回值是包含终止 null 字符的长度，但成功返回值不包括计数中的终止 null 字符。

传递给 GetFullPathName 函数的相对路径将解释为相对于进程的当前目录。由 SetCurrentDirectory 函数写入的当前目录状态是进程的全局状态，随时可由任何线程更改。应用程序应注意，如果当前目录在两个调用之间发生更改，则对 具有相对路径的 getFullPathName 函数的连续调用可能会产生不同的结果。

为了避免由于结果不一致而导致的问题，多线程应用程序和共享库代码应避免使用相对路径。如果收到相对路径，则应恰好使用一次，方法是将相对路径直接传递给 CreateFile等函数，或者将其转换为绝对路径并使用从该点向前的绝对路径。

在 Windows 8 和 Windows Server 2012 中，以下技术支持此函数。

科技	支持
服务器消息块（SMB） 3.0 协议	是的
SMB 3.0 透明故障转移（TFO）	是的
具有横向扩展文件共享的 SMB 3.0 （SO）	是的
群集共享卷文件系统（CsvFS）	是的
可复原文件系统（ReFS）	是的

例子

以下C++示例演示了 GetFullPathName、GetLongPathName和 GetShortPathName的基本用法。有关使用动态分配的另一个示例，请参阅 GetShortPathName。

#include <windows.h>
#include <tchar.h>
#include <stdio.h>

#define BUFSIZE 4096
#define LONG_DIR_NAME TEXT("c:\\longdirectoryname")

void _tmain(int argc, TCHAR *argv[])
{
    DWORD  retval=0;
    BOOL   success; 
    TCHAR  buffer[BUFSIZE]=TEXT(""); 
    TCHAR  buf[BUFSIZE]=TEXT(""); 
    TCHAR** lppPart={NULL};

   if( argc != 2 )
   {
      _tprintf(TEXT("Usage: %s [file]\n"), argv[0]);
      return;
   }

// Retrieve the full path name for a file. 
// The file does not need to exist.

    retval = GetFullPathName(argv[1],
                 BUFSIZE,
                 buffer,
                 lppPart);
    
    if (retval == 0) 
    {
        // Handle an error condition.
        printf ("GetFullPathName failed (%d)\n", GetLastError());
        return;
    }
    else 
    {
        _tprintf(TEXT("The full path name is:  %s\n"), buffer);
        if (lppPart != NULL && *lppPart != 0)
        {
            _tprintf(TEXT("The final component in the path name is:  %s\n"), *lppPart);
        }
    }


// Create a long directory name for use with the next two examples.

    success = CreateDirectory(LONG_DIR_NAME,
                              NULL);

    if (!success)
    {
        // Handle an error condition.
        printf ("CreateDirectory failed (%d)\n", GetLastError());
        return;
    }


// Retrieve the short path name.  

    retval = GetShortPathName(LONG_DIR_NAME,
                  buf,
                  BUFSIZE);

    if (retval == 0) 
    {
        // Handle an error condition.
         printf ("GetShortPathName failed (%d)\n", GetLastError());
         return;
    }
    else _tprintf(TEXT("The short name for %s is %s\n"), 
                  LONG_DIR_NAME, buf);


// Retrieve the long path name.  

    retval = GetLongPathName(buf,
              buffer,
              BUFSIZE);

    if (retval == 0) 
    {
        // Handle an error condition.
         printf ("GetLongPathName failed (%d)\n", GetLastError());
         return;
    }
    else _tprintf(TEXT("The long name for %s is %s\n"), buf, buffer);

// Clean up the directory.

    success = RemoveDirectory(LONG_DIR_NAME);
    if (!success)
    {
        // Handle an error condition.
        printf ("RemoveDirectory failed (%d)\n", GetLastError());
        return;
    }
}

注意

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

要求

要求	价值
最低支持的客户端	Windows XP [桌面应用 \|UWP 应用]
支持的最低服务器	Windows Server 2003 [桌面应用 \|UWP 应用]
目标平台	窗户
标头	fileapi.h （包括 Windows.h）
库	Kernel32.lib
DLL	Kernel32.dll