Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

scrl(3CURSES)

Name

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

Synopsis

cc [ flag ... ] file ... –lcurses [ library ... ]
#include <curses.h>

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

Description

With the scroll() 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() and wscrl() 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().

Return Values

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

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
MT-Level
Unsafe

See Also

curs_outopts(3CURSES), curses(3CURSES), attributes(7)

Notes

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that scrl() and scroll() may be macros.