AddConsoleAlias 函数

项目
12/18/2023

重要

本文档介绍控制台平台功能，该功能已不再是生态系统蓝图的一部分。我们不建议在新产品中使用此内容，但我们未来将无限期支持现有使用。我们的首选最新解决方案侧重于虚拟终端序列，以实现跨平台方案中的最大兼容性。可以在经典控制台与虚拟终端文档中找到有关此设计决策的详细信息。

定义指定可执行文件的控制台别名。

语法

BOOL WINAPI AddConsoleAlias(
  _In_ LPCTSTR Source,
  _In_ LPCTSTR Target,
  _In_ LPCTSTR ExeName
);

参数

Source [in]
要映射到 Target 指定之文本的控制台别名。

Target [in]
要替换为 Source 的文本。如果此参数为 NULL，则删除控制台别名。

ExeName [in]
要为其定义控制台别名的可执行文件的名称。

返回值

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

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

注解

若要编译使用此函数的应用程序，请将 _WIN32_WINNT 定义为 0x0501 或更高版本。有关详细信息，请参阅使用 Windows 标头。

提示

不建议使用此 API，并且此 API 没有虚拟终端等效项。此决定有意使 Windows 平台与其他操作系统保持一致，其中单个客户端应用程序充当 shell 或解释器，其应维护自己的用户便利功能，例如行读取和操作行为（包括别名和命令历史记录）。如果使用此 API，则通过跨平台实用工具和传输（例如 SSH）进行远程处理的应用程序可能无法正常工作。

示例

有关示例，请参阅控制台别名。

要求


最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
标头	ConsoleApi3.h (via WinCon.h, include Windows.h)
库	Kernel32.lib
DLL	Kernel32.dll
Unicode 和 ANSI 名称	AddConsoleAliasW (Unicode) 和 AddConsoleAliasA (ANSI)