SetConsoleCursorInfo関数

  • [アーティクル]

重要

このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。

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

構文

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

パラメーター

hConsoleOutput [in]
コンソール画面バッファーのハンドル。 ハンドルには、GENERIC_READ アクセス権があります。 詳細については、「コンソール バッファーのセキュリティとアクセス権」を参照してください。

lpConsoleCursorInfo [in]
コンソール画面バッファーのカーソルの新しい仕様を提供するCONSOLE_CURSOR_INFO 構造体へのポインター。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

画面バッファのカーソルが表示される場合、その外観は、文字セルを完全に塗りつぶすものからセルの下部に水平線として表示されるものまでさまざまです。 CONSOLE_CURSOR_INFO構造体のdwSize メンバーは、カーソルによって入力される文字セルの割合を指定します。 このメンバーが 1 未満または 100 より大きい場合、 SetConsoleCursorInfo は失敗します。

ヒント

この API には、^[[?25hおよび^[[?25lを含むカーソルの可視性セクションとシーケンスに相当する仮想ターミナルがあります。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー ConsoleApi2.h（WinCon.h 経由、Windows.h を含む）
ライブラリ Kernel32.lib
[DLL] Kernel32.dll

関連項目

コンソール関数

コンソールの画面バッファー

CONSOLE_CURSOR_INFO

GetConsoleCursorInfo

SetConsoleCursorPosition