GetConsoleHistoryInfo 函数
重要
本文档介绍控制台平台功能,该功能已不再是生态系统蓝图的一部分。 我们不建议在新产品中使用此内容,但我们未来将无限期支持现有使用。 我们的首选最新解决方案侧重于虚拟终端序列,以实现跨平台方案中的最大兼容性。 可以在经典控制台与虚拟终端文档中找到有关此设计决策的详细信息。
检索调用进程的控制台的历史记录设置。
语法
BOOL WINAPI GetConsoleHistoryInfo(
_Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);
参数
lpConsoleHistoryInfo [out]
指向 CONSOLE_HISTORY_INFO 结构的指针,该结构接收调用进程的控制台的历史记录设置。
返回值
如果函数成功,则返回值为非零值。
如果函数失败,则返回值为零。 要获得更多的错误信息,请调用 GetLastError。
备注
如果调用进程不是控制台进程,该函数将失败,并将最后一个错误设置为 ERROR_ACCESS_DENIED。
提示
不建议使用此 API,并且此 API 没有虚拟终端等效项。 此决定有意使 Windows 平台与其他操作系统保持一致,其中单个客户端应用程序充当 shell 或解释器,其应维护自己的用户便利功能,例如行读取和操作行为(包括别名和命令历史记录)。 如果使用此 API,则通过跨平台实用工具和传输(例如 SSH)进行远程处理的应用程序可能无法正常工作。
要求
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
标头 | ConsoleApi3.h (via WinCon.h, include Windows.h) |
库 | Kernel32.lib |
DLL | Kernel32.dll |