GetConsoleOriginalTitle 函数

重要

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

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

语法

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

lpConsoleTitle [out]
指向缓冲区的指针，该缓冲区可接收包含原始标题的以 null 结尾的字符串。

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

如果 nSize 为零，则返回值为零。

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

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

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

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

提示

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


最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
Header	ConsoleApi2.h (via WinCon.h, include Windows.h)
库	Kernel32.lib
DLL	Kernel32.dll
Unicode 和 ANSI 名称	GetConsoleOriginalTitleW (Unicode) 和 GetConsoleOriginalTitleA (ANSI)