GetConsoleHistoryInfo 函式
重要
本文件說明已不再是生態系統 藍圖一部分的控制台平臺功能。 我們不建議您在新產品中使用此內容，但我們將繼續支持無限期的未來現有使用量。 我們慣用的新式解決方案著重於 虛擬終端機序列 ，以在跨平臺案例中達到最大相容性。 您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。
擷取呼叫進程主控台的歷程記錄設定。
語法
BOOL WINAPI GetConsoleHistoryInfo(
_Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);
參數
lpConsoleHistoryInfo [out]
CONSOLE_HISTORY_INFO 結構的指標，可接收呼叫進程控制台的歷程記錄設定。
傳回值
如果函式成功，則傳回值為非零值。
如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。
備註
如果呼叫進程不是主控台進程，函式會失敗，並將最後一個錯誤設定為 ERROR_ACCESS_DENIED。
提示
不建議使用此 API，而且沒有 虛擬終端機 對等專案。 此決策會刻意將 Windows 平臺與其他操作系統對齊，其中個別用戶端應用程式作為殼層或解釋器，預期會維護自己的使用者便利性功能，例如行讀和操作行為，包括別名和命令歷程記錄。 透過跨平臺公用程式和 SSH 之類的傳輸進行遠端處理的應用程式在使用這個 API 時可能無法如預期般運作。
需求
| 最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
| 頁首 | ConsoleApi3.h （透過 WinCon.h，包含 Windows.h） |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |