createHardLinkA 函数 (winbase.h)

项目
03/13/2024

在现有文件和新文件之间建立硬链接。此函数仅在 NTFS 文件系统上受支持，仅适用于文件，不适用于目录。

若要以事务处理操作的形式执行此操作，请使用 CreateHardLinkTransacted 函数。

语法

BOOL CreateHardLinkA(
  [in] LPCSTR                lpFileName,
  [in] LPCSTR                lpExistingFileName,
       LPSECURITY_ATTRIBUTES lpSecurityAttributes
);

参数

[in] lpFileName

新文件的名称。

此参数可能包含路径，但不能指定目录的名称。

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

提示

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

[in] lpExistingFileName

现有文件的名称。

此参数可能包含无法指定目录名称的路径。

提示

lpSecurityAttributes

保留;必须为 NULL。

返回值

如果该函数成功，则返回值为非零值。

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

可以使用此函数创建的最大硬链接数为每个文件 1023 个。如果为文件创建了超过 1023 个链接，则会导致错误。

如果将长度超过 MAX_PATH 个字符的名称传递给此函数的 ANSI 版本的 lpFileName 或 lpExistingFileName 参数或此函数的 Unicode 版本，而不将“\？\”附加到路径，则函数将返回ERROR_PATH_NOT_FOUND。

注解

使用 CreateFile 或 CreateHardLink 创建的文件的任何目录条目都是关联文件的硬链接。使用 CreateHardLink 函数创建的其他硬链接允许你为一个文件创建多个目录条目，即指向同一文件的多个硬链接，这些硬链接可以是同一目录中的不同名称，也可以是不同目录中的相同或不同名称。但是，指向文件的所有硬链接都必须位于同一卷上。

由于硬链接只是文件的目录条目，因此，通过引用该文件的硬链接访问该文件的应用程序可立即看到对该文件所做的许多更改。但是，仅针对进行更改的链接更新目录条目大小和属性信息。

安全描述符属于硬链接指向的文件。链接本身只是一个目录条目，没有安全描述符。因此，更改硬链接的安全描述符时，会更改基础文件的安全描述符，并且指向该文件的所有硬链接都允许新指定的访问。不能为每个硬链接为文件提供不同的安全描述符。

此函数不会修改要链接到的文件的安全描述符，即使安全描述符信息是在 lpSecurityAttributes 参数中传递的。

使用 DeleteFile 删除硬链接。可以按任何顺序删除它们，而不考虑它们的创建顺序。

CreateFile 中指定的标志、属性、访问和共享按文件运行。也就是说，如果打开不允许共享的文件，则其他应用程序无法通过创建指向该文件的新硬链接来共享该文件。

在 NTFS 文件系统上创建硬链接时，仅当打开文件或使用特定文件的句柄调用 GetFileInformationByHandle 时，才会刷新目录条目中的文件属性信息。

符号链接行为 - 如果路径指向符号链接，函数将创建指向符号链接的硬链接。

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

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

请注意，SMB 3.0 不支持在具有持续可用性功能的共享上创建硬链接。

示例

以下代码片段演示如何调用 CreateHardLink ，使其不修改文件的安全描述符。 pszExistingFileName 参数可以是原始文件名，也可以是指向文件的任何现有链接。执行此代码后， pszNewLinkName 将引用文件。

  BOOL fCreatedLink = CreateHardLink( pszNewLinkName, 
                                      pszExistingFileName, 
                                      NULL ); // reserved, must be NULL

  if ( fCreatedLink == FALSE )
   {
    ;// handle error condition
   }

注意

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

要求

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