xref: /illumos-gate/usr/src/man/man3xcurses/ripoffline.3xcurses (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
RIPOFFLINE 3XCURSES "Jun 5, 2002"
NAME
ripoffline - reserve screen line for dedicated purpose
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -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 Standard
MT-Level Unsafe
SEE ALSO

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