scrl, scroll, wscrl Subroutine

AIX Version 4.3 Base Operating System and Extensions Technical Reference, Volume 2

scrl, scroll, wscrl Subroutine

Purpose

Scrolls a Curses window.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

int scrl
(int n);

int scroll
(WINDOW *win);

int wscrl
(WINDOW *win,
int n);

Description

The scroll subroutine scrolls win one line in the direction of the first line

The scrl and wscrl subroutines scroll the current or specified window. If n is positive, the window scrolls n lines toward the first line. Otherwise, the window scrolls -n lines toward the last line.

Theses subroutines do not change the cursor position. If scrolling is disabled for the current or specified window, these subroutines have no effect. The interaction of these subroutines with the setsccreg subroutine is currently unspecified.

Parameters

*win	Specifies the window to scroll.
n

Return Values

Upon successful completion, these subroutines return OK. Otherwise, they return ERR.

Examples

To scroll the user-defined window my_window up one line, enter:

WINDOW *my_window;
scroll(my_window);

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The scrollok subroutine.

Curses Overview for Programming, List of Curses Subroutines, Manipulating Characters with Curses in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.