Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ripoffline(3XCURSES)

Name

ripoffline - reserve screen line for dedicated purpose

Synopsis

cc [ flag... ] file... –I /usr/xpg4/include –L /usr/xpg4/lib \
–R /usr/xpg4/lib –lcurses [ library... ]

c89 [ flag... ] file... –lcurses [ library... ]

#include <curses.h>

int ripoffline(int line, int (*init)(WINDOW *win, int width));

Parameters

line

determines whether the screen line being reserved comes from the top of stdscr (line is positive) or the bottom (line is negative).

init

Is a pointer to a function that initializes the one-line window.

win

Is a pointer to one-line window created by this function.

width

Is the number of columns in the window pointed to by the win parameter.

Description

The ripoffline() function reserves a screen line as a one line window.

To use this function, it must be called before you call initscr(3XCURSES) or newterm(3XCURSES). When initscr() or newterm() is called, so is the function pointed to by init. The function pointed to by init takes two arguments: a pointer to the one-line window and the number of columns in that window. This function cannot use the LINES or COLS variables and cannot call wrefresh(3XCURSES) or doupdate(3XCURSES), but may call wnoutrefresh(3XCURSES).

Return Values

The rioffline() function always returns OK.

Errors

None.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard

See Also

doupdate(3XCURSES), initscr(3XCURSES), libcurses(3XCURSES), slk_attroff(3XCURSES), attributes(7), standards(7)