createSymbolicLinkA 函数 (winbase.h)

  • 项目

创建符号链接。

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

语法

BOOLEAN CreateSymbolicLinkA(
  [in] LPCSTR lpSymlinkFileName,
  [in] LPCSTR lpTargetFileName,
  [in] DWORD  dwFlags
);

参数

[in] lpSymlinkFileName

要创建的符号链接。

此参数可能包括 路径。

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

提示

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

[in] lpTargetFileName

要创建的符号链接的目标的名称。

如果 lpTargetFileName 具有与之关联的设备名称，则链接被视为绝对链接;否则，该链接被视为相对链接。

此参数可能包括 路径。

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

提示

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

[in] dwFlags

指示链接目标 lpTargetFileName 是否为目录。

值 含义
0x0
 链接目标是文件。
SYMBOLIC_LINK_FLAG_DIRECTORY
0x1
 链接目标是目录。
SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE
0x2
 指定此标志以允许在进程未提升时创建符号链接。 在 UWP 中，必须先在计算机上启用 开发人员模式 ，此选项才能正常工作。 在 MSIX 下，无需为此标志启用开发人员模式。

返回值

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

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

注解

符号链接可以是绝对链接或相对链接。 绝对链接是指定路径名称的每个部分的链接；相对链接是相对于相对链接说明符在指定路径中的位置确定的。 使用以下约定指定相对链接：

  • 点（. 和 ..）约定，例如“..\“ 解析相对于父目录的路径。
  • 没有斜杠的名称 (\\) ，例如，“tmp”解析相对于当前目录的路径。
  • 根相对-例如，“\Windows\System32”解析为“当前驱动器：\Windows\System32”。
  • 当前工作目录相对 - 例如，如果当前工作目录为 C：\Windows\System32，则“C:File.txt”解析为“C:\Windows\System32\File.txt”。
    注意 如果指定当前工作目录相对链接，则会将其创建为绝对链接，具体取决于基于用户和线程处理当前工作目录的方式。
     
若要删除符号链接，请使用 DeleteFile 或类似 API) 删除文件 (文件，或使用 RemoveDirectory 或类似 API) 删除目录 (，具体取决于所使用的符号链接的类型。

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

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

CsvF 不支持软链接或任何其他重新分析点。

注意

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

要求

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

另请参阅

CreateSymbolicLinkTransacted

文件管理函数

符号链接