SetConsoleCursorPosition関数

重要

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

指定したコンソール画面バッファー内のカーソル位置を設定します。

構文

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

パラメーター

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

dwCursorPosition [in]
新しいカーソル位置を文字で指定するCOORD構造体。 座標は、画面バッファー文字セルの列と行です。 座標は、コンソール画面バッファーの境界内にある必要があります。

戻り値

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

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

解説

カーソル位置は、WriteFile または WriteConsole 関数によって書き込まれた文字、または ReadFile または ReadConsole 関数によってエコーされる文字が表示される場所を決定します。 カーソルの現在位置を確認するには、GetConsoleScreenBufferInfo 関数を使用します。

新しいカーソル位置がコンソール画面バッファーのウィンドウの境界内にない場合、ウィンドウの原点が変更され、カーソルが表示されます。

ヒント

この API には、単純なカーソル位置セクションとカーソル配置セクションに相当する仮想ターミナルがあります。 改行、復帰、バックスペース、およびタブ制御シーケンスの使用は、カーソルの配置にも役立ちます。

例

例については、「高レベルの入出力関数の使用」を参照してください。

要件

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

関連項目

コンソール関数

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

GetConsoleCursorInfo

GetConsoleScreenBufferInfo

ReadConsole

ReadFile

SetConsoleCursorInfo

WriteConsole

WriteFile