curs_scroll(S-osr5)

curs_scroll: scroll, scrl, wscrl -- scroll a curses window

Syntax

cc ... -lcurses

#include <curses.h>

int scroll(WINDOW *win);
int scrl(int n);
int wscrl(WINDOW *win, int n);

Description

With the scroll(S-osr5) routine, the window is scrolled up one line. This involves moving the lines in the window data structure. As an optimization, if the scrolling region of the window is the entire screen, the physical screen is scrolled at the same time.

With the scrl(S-osr5) and wscrl(S-osr5) routines, for positive n scroll the window up n lines (line i+n becomes i); otherwise scroll the window down n lines. This involves moving the lines in the window character image structure. The current cursor position is not changed.

For these functions to work, scrolling must be enabled via scrollok(S-osr5).

Return values

All routines return the integer ERR on failure and an integer value other than ERR on successful completion.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

The following can be macros: scrl( ) and scroll( ).

Files

/usr/lib/libcurses.a: the library

Standards conformance

scroll(S-osr5), scrl(S-osr5), and wscrl(S-osr5) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.