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,而且沒有 虛擬終端機 對等專案。 此決策會刻意將 Windows 平臺與其他操作系統對齊。 透過跨平臺公用程式和 SSH 之類的傳輸進行遠端處理的應用程式在使用這個 API 時可能無法如預期般運作。
需求
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
頁首 | ConsoleApi2.h (透過 WinCon.h,包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |
Unicode 和 ANSI 名稱 | GetConsoleOriginalTitleW (Unicode) 和 GetConsoleOriginalTitleA (ANSI) |