SetConsoleScreenBufferSize 函式

  • 發行項

重要

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

變更指定主控台畫面緩衝區的大小。

語法

BOOL WINAPI SetConsoleScreenBufferSize(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwSize
);

參數

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

dwSize [in]
COORD 結構，指定控制台畫面緩衝區的新大小，以字元列和數據行為單位。 指定的寬度和高度不能小於控制台螢幕緩衝區視窗的寬度和高度。 指定的維度也不能小於系統允許的大小下限。 此最小值取決於主控台目前的字型大小（由使用者選取），以及 GetSystemMetrics 函式所傳回的SM_CXMIN和SM_CYMIN值。

傳回值

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

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

備註

提示

不建議使用此 API，而且沒有 虛擬終端機 對等專案。 此決策會刻意將 Windows 平臺與其他操作系統一致，而該操作系統會授與使用者對此簡報選項的完整控制權。 透過跨平臺公用程式和 SSH 之類的傳輸進行遠端處理的應用程式在使用這個 API 時可能無法如預期般運作。

需求

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

另請參閱

主控台函式

主控台輸入緩衝區

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo