WriteConsoleOutputCharacter関数

[アーティクル]
12/15/2023

重要

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

指定した位置から始まる、コンソール画面バッファーの連続するセルに文字数をコピーします。

構文

BOOL WINAPI WriteConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _In_  LPCTSTR lpCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfCharsWritten
);

パラメーター

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

lpCharacter [in]
コンソール画面バッファーに書き込む文字。

nLength [in]
書き込む文字数です。

dwWriteCoord [in]
文字の書き込み先となるコンソール画面バッファー内の最初のセルの文字座標を指定する COORD 構造体。

lpNumberOfCharsWritten [out]
実際に書き込まれた文字数を受け取る変数のポインター。

戻り値

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

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

解説

書き込む文字数がコンソール画面バッファー内の指定された行の末尾を超える場合、文字は次の行に書き込まれます。書き込む文字数がコンソール画面バッファーの末尾を超える場合は、コンソール画面バッファーの末尾まで文字が書き込まれます。

書き込まれる位置の属性値は変更されません。

この関数では、Unicode 文字またはコンソールの現在のコードページの 8 ビット文字が使用されます。コンソールのコードページには、最初はシステムの OEM コードページが既定で設定されます。コンソールのコードページを変更するには、SetConsoleCP または SetConsoleOutputCP 関数を使用します。従来のユーザーは、chcp または mode con cp select= コマンドを使用することもできますが、それは新規の開発ではお勧めできません。

ヒント

この API には、テキストの書式設定とカーソルの配置シーケンスに相当する仮想ターミナルがあります。カーソルを挿入する場所に移動し、必要な書式を適用して、入力するテキストを書き出します。アクティブな色の書式設定も適用せずに、領域にテキストを出力することに相当するものはありません。この決定により、Windows プラットフォームは、個々のクライアントアプリケーションがそれ自体の描画状態を記憶してさらに操作することが期待される他のオペレーティングシステムと意図的に調整されます。

要件


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

WriteConsoleOutputCharacter関数

構文

パラメーター

戻り値

解説

要件

関連項目

フィードバック

フィードバック

その他のリソース