GetConsoleScreenBufferInfo 函式

發行項
12/13/2023

擷取指定控制台畫面緩衝區的相關信息。

語法

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

參數

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

lpConsoleScreenBufferInfo [out]
接收主控台畫面緩衝區資訊的CONSOLE_SCREEN_BUFFER_INFO結構的指標。

傳回值

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

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

備註

您可以在CONSOLE_SCREEN_BUFFER_INFO結構的 srWindow 成員中傳回矩形，然後傳遞至 SetConsoleWindowInfo 函式，以捲動視窗中的控制台畫面緩衝區、變更視窗的大小或兩者。

在CONSOLE_SCREEN_BUFFER_INFO結構中傳回的所有座標都位於字元單元格座標中，其中原點（0， 0）位於控制台畫面緩衝區的左上角。

提示

此 API 沒有 虛擬終端機 對等專案。嘗試繪製數據行、方格或填滿顯示以擷取視窗大小的應用程式，仍可能需要使用它。此視窗狀態是由一般數據流外部的TTY/PTY/Pseudoconsole 所管理，通常被視為用戶端應用程式無法調整的用戶許可權。更新可以接收於ReadConsoleInput。

範例

如需範例，請參閱卷動螢幕緩衝區的視窗。

需求


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