xref: /illumos-gate/usr/src/man/man3xcurses/clear.3xcurses (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
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]
CLEAR 3XCURSES "Jun 5, 2002"
NAME
clear, erase, wclear, werase - clear a window
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 clear(void);

int erase(void);

int wclear(WINDOW *win);

int werase(WINDOW *win);
DESCRIPTION

The clear() and erase() functions clear stdscr, destroying its previous contents. The wclear() and werase() functions perform the same action, but clear the window specified by win instead of stdscr.

The clear() and wclear() functions also call the clearok() function. This function clears and redraws the entire screen on the next call to refresh(3XCURSES) or wrefresh(3XCURSES) for the window.

The current background character (and attributes) is used to clear the screen.

PARAMETERS
win

Is a pointer to the window that is to be cleared.

ERRORS
OK

Successful completion.

ERR

An error occurred.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

bkgdset (3XCURSES), clearok (3XCURSES), clrtobot (3XCURSES), clrtoeol (3XCURSES), doupdate (3XCURSES), libcurses (3XCURSES), refresh (3XCURSES), wrefresh (3XCURSES), attributes (7), standards (7)