ReadConsoleOutputAttribute

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

ReadConsoleOutputAttribute hConsoleOutput, lpAttribute, nLength, dwReadCoord, lpNumberOfAttrsRead

hConsoleOutput : [intptr] コンソールスクリーンバッファへのハンドル。ハンドルは **GENERIC\_READ** アクセス権を持つ必要がある。詳細は [Console Buffer Security and Access Rights](console-buffer-security-and-access-rights.md) を参照。
lpAttribute : [var] コンソールスクリーンバッファで使用されている属性を受け取るバッファへのポインタ。詳細は [Character Attributes](console-screen-buffers.md#character-attributes) を参照。
nLength : [int] 読み取り元のスクリーンバッファ文字セル数。*lpAttribute* パラメータが指すバッファのサイズは `nLength * sizeof(WORD)` であるべきである。
dwReadCoord : [var] 読み取りを開始するコンソールスクリーンバッファ内の最初のセルの座標(文字単位)。[**COORD**](coord-str.md) 構造体の **X** メンバは列、**Y** メンバは行を表す。
lpNumberOfAttrsRead : [var] 実際に読み取られた属性の数を受け取る変数へのポインタ。

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

解説

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

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

[備考]

読み取る属性数が指定したスクリーンバッファ行の末尾を越える場合、次の行から属性が読み取られる。読み取る属性数がコンソールスクリーンバッファの末尾を越える場合、コンソールスクリーンバッファの末尾までの属性が読み取られる。[!INCLUDE
[no-vt-equiv-banner](./includes/no-vt-equiv-banner.md)]

情報