ConSetPageSize command

 

Usage:

ConSetPageSize Rows&, Cols&

 

Legacy Syntax:

CONSOLE SET VIRTUAL Rows&, Cols&

 

Pseudo-object Syntax:

CON.VIRTUAL = Rows&, Cols&

 

Sets the size of the console output page buffers.

 

A console page may be larger than the visible console screen. If a page size larger than the visible screen is created with ConSetPageSize, scroll bars are automatically added to the visible screen to allow the user to examine the entire page buffer.

 

When you execute ConSetPageSize, the size of the buffer for each console page is changed to the rows and columns specified. Each dimension must be larger or equal to the corresponding dimension of the screen size.

 

Once the console buffer size has been altered, the new size can be retrieved using the ConGetPageSize function.

 

ConSetPageSize can be used as a function. If it succeeds, the return value is 1. If it does not succeed, the return value is 0. If it does not succeed, this is most likely caused by one or both of the parameters being too large for available memory, or smaller than the visible console screen size.

 

Conversion:

 

#IF %DEF(%PB_CC32)

  CONSOLE SET VIRTUAL Rows&, Cols&

#ELSE

  ConSetPageSize Rows&, Cols&

#ENDIF

 

CON.VIRTUAL = or CONSOLE.VIRTUAL = may be substituted for CONSOLE SET VIRTUAL in programs written for PB/CC 6.

 

#IF %DEF(%PB_CC32)

  CON.VIRTUAL = Rows&, Cols&

#ELSE

  ConSetPageSize Rows&, Cols&

#ENDIF

 

See Also: ConSetScreenSize, ConGetPageSize