Console_SaveScreen

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > Console >

Console_SaveScreen

 

Description

 

Save a console screen portion into a string buffer.

 

Syntax

 

s = Console_SaveScreen(x1, y1, x2, y2)

 

Returns

 

String

 

Parameters

 

Name

Type

Optional

Meaning

x1

Number

No

Starting x position

y1

Number

No

Starting y position

x2

Number

No

Ending x position

y2

Number

No

Ending y position

 

Remarks

 

Returning string will contain an header record information followed by char/attribute pair bytes for every screen position saved.

 

Header record has the following structure:

Type tScreenBuffersInfo

  id      As Long     '---Identifier of a screen buffer

  x1      As Long     '---Start upper/left corner x

  y1      As Long     '---Start upper/left corner y

  x2      As Long     '--- End lower/right corner x

  y2      As Long     '--- End lower/right corner y

  nCols   As Long     '---Number of columns in buffer

  nRows   As Long     '---Number of rows in buffer

End Type

 

Restrictions

 

See also

 

Examples