共用方式為


SetConsoleCursorInfo 函式

重要

本文件說明已不再是生態系統 藍圖一部分的控制台平臺功能。 我們不建議您在新產品中使用此內容,但我們將繼續支持無限期的未來現有使用量。 我們慣用的新式解決方案著重於 虛擬終端機序列 ,以在跨平臺案例中達到最大相容性。 您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。

設定指定主控台畫面緩衝區之游標的大小和可見性。

語法

BOOL WINAPI SetConsoleCursorInfo(
  _In_       HANDLE              hConsoleOutput,
  _In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);

參數

hConsoleOutput [in]
主控台螢幕緩衝區的控點。 句柄必須具有 GENERIC_READ 訪問許可權。 如需詳細資訊,請參閱主控台緩衝區安全性和存取權限

lpConsoleCursorInfo [in]
CONSOLE_CURSOR_INFO結構的指標,提供控制台畫面緩衝區游標的新規格。

傳回值

如果函式成功,則傳回非零的值。

如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError

備註

當螢幕緩衝區的游標可見時,其外觀可能會有所不同,從完全填滿字元儲存格到在儲存格底部顯示為水平線不等。 CONSOLE_CURSOR_INFO 結構的 dwSize 成員會指定數據指標所填入之字元儲存格的百分比。 如果這個成員小於 1 或大於 100,SetConsoleCursorInfo 就會失敗。

提示

此 API 在具有 和 ^[[?25l 序列的數據指標可見性區段中^[[?25h具有對等的虛擬終端機。

需求

   
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
頁首 ConsoleApi2.h (透過 WinCon.h,包含 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

主控台函式

主控台畫面緩衝區

CONSOLE_CURSOR_INFO

GetConsoleCursorInfo

SetConsoleCursorPosition