SetConsoleCursorInfo

指定したコンソール画面バッファのカーソルのサイズと可視性を設定する。

SetConsoleCursorInfo hConsoleOutput, lpConsoleCursorInfo

hConsoleOutput : [intptr] コンソール画面バッファへのハンドル。ハンドルには **GENERIC\_READ** アクセス権が必要である。詳細は [コンソールバッファのセキュリティとアクセス権](console-buffer-security-and-access-rights.md) を参照。
lpConsoleCursorInfo : [var] コンソール画面バッファのカーソルに関する新しい設定を提供する [**CONSOLE\_CURSOR\_INFO**](console-cursor-info-str.md) 構造体へのポインタ。

(プラグイン / モジュール : kernel32.dll)

解説

指定したコンソール画面バッファのカーソルのサイズと可視性を設定する。

[戻り値]
関数が成功した場合、戻り値は非ゼロである。失敗した場合はゼロである。拡張エラー情報を取得するには
[**GetLastError**](/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)
を呼び出す。

[備考]

画面バッファのカーソルが可視のとき、その見た目は文字セルを完全に埋めるものからセル下部の横線まで多様である。[**CONSOLE\_CURSOR\_INFO**](console-cursor-info-str.md)
構造体の **dwSize** メンバはカーソルが文字セルを占める割合 (パーセント) を指定する。このメンバが 1 未満または 100
より大きい場合、**SetConsoleCursorInfo** は失敗する。> [!TIP] > この API は
**[仮想ターミナル](console-virtual-terminal-sequences.md)** の
**[カーソル可視性](console-virtual-terminal-sequences.md#cursor-visibility)**
セクションの `^[[?25h` および `^[[?25l` シーケンスに相当する。

情報