Cicode Programming Reference > Cicode Function Categories > Display Functions > DspFileScroll

DspFileScroll

Scrolls a file (displayed in the display "window") by a number of characters.

Syntax

DspFileScroll(nAN, Direction, Characters)

nAN:

The animation-point number.

Direction:

The direction in which to scroll:

1 - Left

2 - Right

3 - Up

4 - Down

Characters:

The number of characters to scroll. To page up or page down through the file, scroll by the height of the file-to-screen window (returned by DspFileGetInfo(AN, 1)).

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

DspFile, DspFileGetInfo, DspFileSetName, DspFileGetName

Example

Page Keyboard

Key Sequence

PgUp

Command

DspFileScroll(20,3,10)

Comment

Scroll up 10 lines

See Also

Display Functions

Published June 2018