ReadConsoleOutputAttribute 関数

重要

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

指定した位置から始まる、コンソール スクリーン バッファーの連続するセルから、指定された数の文字属性をコピーします。

構文

BOOL WINAPI ReadConsoleOutputAttribute(
  _In_  HANDLE  hConsoleOutput,
  _Out_ LPWORD  lpAttribute,
  _In_  DWORD   nLength,
  _In_  COORD   dwReadCoord,
  _Out_ LPDWORD lpNumberOfAttrsRead
);

パラメーター

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

lpAttribute [out]
コンソール スクリーン バッファーで使用されている属性を受け取るバッファーへのポインター。

詳細については、「文字の属性」を参照してください。

nLength [in]
読み取り元のスクリーン バッファー文字セルの数。 lpAttribute パラメーターが指すバッファーのサイズは nLength * sizeof(WORD) になります。

dwReadCoord [in]
読み取り元のコンソール スクリーン バッファー内の最初のセルの座標 (文字単位)。 COORD 構造体の X メンバーは列であり、Y メンバーは行です。

lpNumberOfAttrsRead [out]
実際に読み込まれた属性数を受け取る変数へのポインター。

戻り値

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

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

解説

読み込む属性の数が指定されたスクリーン バッファー行の末尾を超えて拡張される場合、属性は次の行に読み込まれます。 読み込まれる属性の数がコンソール スクリーン バッファーの末尾を超えて拡張する場合、属性はコンソール スクリーン バッファーの末尾まで読み込まれます。

ヒント

この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定により、Windows プラットフォームは、個々のクライアント アプリケーションがそれ自体の描画状態を記憶してさらに操作することが期待される他のオペレーティング システムと意図的に調整されます。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。

要件

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

関連項目

コンソール関数

COORD

低レベル コンソール出力関数

ReadConsoleOutput

ReadConsoleOutputCharacter

WriteConsoleOutput

WriteConsoleOutputAttribute

WriteConsoleOutputCharacter