GetScreen

このメソッドは、ECLPS オブジェクトに関連した接続の 表示スペースからデータを取り出します。データは、表示スペースの文字位置あたり 1 バイトずつの、 バイト値の線形配列で戻されます。データが TextPlane から取り出される (その場合、単一のヌル終了バイトが 付加されます) 場合を除き、配列はヌル終了しません。

アプリケーションは、戻されるデータ用のバッファーとそのバッファーの長さ を指定しなければなりません。要求データは、バッファーに収容しきれない場合、切り捨てられ ます。TextPlane データの場合、バッファーには、終了ヌル用に 少なくとも 1 バイトが余分に含まれていなければなりません。このメソッドは、アプリケーション・バッファーにコピーされたバイト数 を戻します (TextPlane コピーでの終了ヌルは含まれません)。

アプリケーションは、表示スペースから取り出すデータのバイト数を 指定しなければなりません。開始位置にその長さを加えたものが表示スペースのサイズを超える場合、 エラーになります。データは、指定された開始位置を先頭にして戻されますが、 開始位置を指定しないと、行 1 桁 1 に戻されます。戻されたデータは、左から右および上から下へと複数行にわたって指定された長さまで、線形方式で表示スペースからコピーされます。アプリケーションが画面の長方形領域の画面データを取得 したい場合、GetScreenRect メソッドを使用してください。

アプリケーションは、データの取り出しの対象に任意のプレーンを指定することができます。プレーンを指定しない場合は、TextPlane が取り出されます。その他の ECL プレーンの詳細については、ECL プレーン — 形式および内容を参照してください。