ReadConsoleOutputCharacterW

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

ReadConsoleOutputCharacterW hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead

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

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

解説

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

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

[備考]

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

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs