scroll(3xcurses)

1scrl(3XCURSES)          X/Open Curses Library Functions         scrl(3XCURSES)
2
3
4

NAME

6       scrl, scroll, wscrl - scroll a window
7

SYNOPSIS

9       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
10        -R  /usr/xpg4/lib  -lcurses  [ library... ]
11
12       c89 [ flag... ] file... -lcurses [ library... ]
13
14       #include <curses.h>
15
16       int scrl(int n);
17
18
19       int scroll(WINDOW *win);
20
21
22       int wscrl(WINDOW *win, int n);
23
24

PARAMETERS

26       n      number and direction of lines to scroll
27
28
29       win    pointer to the window in which to scroll
30
31

DESCRIPTION

33       The  scroll() function scrolls the window win up one line.  The current
34       cursor position is not changed.
35
36
37       The scrl() and wscrl() functions scroll the window stdscr or win up  or
38       down  n  lines,  where  n is a positive (scroll up) or negative (scroll
39       down) integer.
40
41
42       The scrollok(3XCURSES) function must be enabled for these functions  to
43       work.
44

RETURN VALUES

46       On success, these functions return OK. Otherwise, they return ERR.
47

ERRORS

49       None.
50

ATTRIBUTES

52       See attributes(5) for descriptions of the following attributes:
53
54
55
56
57       ┌─────────────────────────────┬─────────────────────────────┐
58       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
59       ├─────────────────────────────┼─────────────────────────────┤
60       │Interface Stability          │Standard                     │
61       ├─────────────────────────────┼─────────────────────────────┤
62       │MT-Level                     │Unsafe                       │
63       └─────────────────────────────┴─────────────────────────────┘
64