GetConsoleTitle 函式
重要
本文件說明已不再是生態系統 藍圖一部分的控制台平臺功能。 我們不建議您在新產品中使用此內容，但我們將繼續支持無限期的未來現有使用量。 我們慣用的新式解決方案著重於 虛擬終端機序列 ，以在跨平臺案例中達到最大相容性。 您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。
擷取目前控制台視窗的標題。
語法
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，而且沒有 虛擬終端機 對等專案。 此決策會刻意將 Windows 平臺與其他操作系統對齊。 透過跨平臺公用程式和 SSH 之類的傳輸進行遠端處理的應用程式在使用這個 API 時可能無法如預期般運作。
範例
如需範例，請參閱 SetConsoleTitle。
需求
| 最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
| 頁首 | ConsoleApi2.h （透過 WinCon.h，包含 Windows.h） |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |
| Unicode 和 ANSI 名稱 | GetConsoleTitleW （Unicode） 和 GetConsoleTitleA （ANSI） |