GetConsoleScreenBufferInfo 関数
指定したコンソール スクリーン バッファーに関する情報を取得します。
構文
BOOL WINAPI GetConsoleScreenBufferInfo(
_In_ HANDLE hConsoleOutput,
_Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);
パラメーター
hConsoleOutput [in]
コンソール画面バッファーのハンドル。 ハンドルには、GENERIC_READ アクセス権があります。 詳細については、「コンソール バッファーのセキュリティとアクセス権」を参照してください。
lpConsoleScreenBufferInfo [out]
コンソール スクリーン バッファー情報を受信する CONSOLE_SCREEN_BUFFER_INFO 構造体へのポインター。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
CONSOLE_SCREEN_BUFFER_INFO 構造体の srWindow メンバーで返される四角形を変更してから、SetConsoleWindowInfo 関数に渡して、ウィンドウ内のコンソール スクリーン バッファーをスクロールしたり、ウィンドウのサイズを変更したり、またはその両方を行ったりすることができます。
CONSOLE_SCREEN_BUFFER_INFO 構造体で返されるすべての座標は文字セル座標内にあり、原点 (0, 0) はコンソール スクリーン バッファーの左上隅にあります。
ヒント
この API は同等の 仮想ターミナル はありません。 ウィンドウ サイズを取得するために、列、グリッドを描画する、またはディスプレイを埋めようとしているアプリケーションでは、その使用が必要な場合があります。 このウィンドウの状態は、通常のストリーム フローの外部にある TTY/PTY/疑似コンソールによって管理され、一般に、クライアント アプリケーションでは調整できないユーザー権限と見なされます。 更新は、ReadConsoleInput で受け取られます。
例
例については、「画面バッファーのウィンドウのスクロール」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー | ConsoleApi2.h（WinCon.h 経由、Windows.h を含む） |
| ライブラリ | Kernel32.lib |
| [DLL] | Kernel32.dll |