GetConsoleTitle 函数

项目
12/18/2023

重要

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

检索当前控制台窗口的标题。

语法

DWORD WINAPI GetConsoleTitle(
  _Out_ LPTSTR lpConsoleTitle,
  _In_  DWORD  nSize
);

参数

lpConsoleTitle [out]
指向缓冲区的指针，该缓冲区可接收包含标题的以 null 结尾的字符串。如果缓冲区太小而无法存储标题，则函数将存储缓冲区中适合的标题字符数，以 null 终止符结尾。

nSize [in]
lpConsoleTitle 参数所指向的缓冲区大小（以字符为单位）。

返回值

如果函数成功，则返回值为控制台窗口标题的长度（以字符为单位）。

如果函数失败，则返回值为零，并且 GetLastError 返回错误代码。

备注

若要为控制台窗口设置标题，请使用 SetConsoleTitle 函数。若要检索原始标题字符串，请使用 GetConsoleOriginalTitle 函数。

此函数使用控制台当前代码页中的 Unicode 字符或 8 位字符。控制台的代码页最初默认为系统的 OEM 代码页。若要更改控制台的代码页，请使用 SetConsoleCP 或 SetConsoleOutputCP 函数。旧版使用者也可以使用 chcp 或 mode con cp select= 命令，但不建议将其用于新开发。

提示

不建议使用此 API，并且此 API 没有虚拟终端等效项。此决策有意使 Windows 平台与其他操作系统保持一致。如果使用此 API，则通过跨平台实用工具和传输（例如 SSH）进行远程处理的应用程序可能无法正常工作。

示例

如需示例，请参阅 SetConsoleTitle。

要求


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