getFullPathNameTransactedA 函数 (winbase.h)

项目
03/03/2024

[Microsoft 强烈建议开发人员使用替代方法来实现应用程序的需求。 TxF 致力于实现的许多方案都可以通过更简单、更易用的技术来实现。此外，TxF 在 Microsoft Windows 的将来版本中可能不可用。有关详细信息，以及 TxF 的替代方法，请参阅事务性 NTFS 的替代方法。]

以事务处理操作的形式检索指定文件的完整路径和文件名。

若要在没有事务的情况下执行此操作，请使用 GetFullPathName 函数。

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

语法

DWORD GetFullPathNameTransactedA(
  [in]  LPCSTR lpFileName,
  [in]  DWORD  nBufferLength,
  [out] LPSTR  lpBuffer,
  [out] LPSTR  *lpFilePart,
  [in]  HANDLE hTransaction
);

参数

[in] lpFileName

文件的名称。

此字符串可以使用短 (8.3 格式) 或长文件名。此字符串可以是共享名称或卷名称。

文件必须驻留在本地计算机上;否则，函数将失败，最后一个错误代码设置为 ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE。

[in] nBufferLength

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

[out] lpBuffer

指向缓冲区的指针，该缓冲区接收驱动器和路径的以 null 结尾的字符串。

[out] lpFilePart

指向缓冲区的指针，该缓冲区接收路径中最终文件名组件的 lpBuffer) 地址 (。如果不需要接收此信息，请指定 NULL 。

如果 lpBuffer 指向目录而不是文件， 则 lpFilePart 接收 0 (零) 。

[in] hTransaction

事务的句柄。此句柄由 CreateTransaction 函数返回。

返回值

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

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

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

注解

GetFullPathNameTransacted 将当前驱动器和目录的名称与指定的文件名合并，以确定指定文件的完整路径和文件名。它还计算完整路径和文件名的文件名部分的地址。此函数不会验证生成的路径和文件名是否有效，或者它们是否在关联的卷上看到了现有文件。

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

如果指定“\\test-2\q$\lh”，则返回的路径为“\\test-2\q$\lh”
如果指定“\\？\UNC\test-2\q$\lh”，则返回的路径为“\\？\UNC\test-2\q$\lh”
如果指定“U：”，则返回的路径为“U：\”

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

如果返回值大于 nBufferLength 中指定的值，则可以使用足以保存路径的缓冲区再次调用函数。有关这种情况的示例以及使用零长度缓冲区进行动态分配，请参阅示例代码部分。

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

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

技术	支持
服务器消息块 (SMB) 3.0 协议	否
SMB 3.0 透明故障转移 (TFO)	否
具有横向扩展文件共享的 SMB 3.0 (SO)	否
群集共享卷文件系统 (CSV)	否
弹性文件系统 (ReFS)	否

SMB 3.0 不支持 TxF。

注意

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

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	winbase.h (包括 Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll