opensolaris man page for clrtobot

clrtobot(3XCURSES)					  X/Open Curses Library Functions					clrtobot(3XCURSES)

NAME
       clrtobot, wclrtobot - clear to the end of a window

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 clrtobot(void);

       int wclrtobot(WINDOW *win);

DESCRIPTION
       The clrtobot() function clears all characters in the stdscr  window from the cursor to the end of the window. The wclrtobot() function per-
       forms the same action in the window  specified by win instead of in stdscr. The current background character (and  rendition)  is  used	to
       clear the screen.

       If  the clearing action results in clearing only a portion of a multicolumn  character, background characters are displayed in place of the
       remaining portion.

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

RETURN VALUES
       On success, these functions return OK. Otherwise, they return ERR.

ERRORS
       None.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       bkgdset(3XCURSES), clear(3XCURSES), clearok(3XCURSES), clrtoeol(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)

SunOS 5.11							    5 Jun 2002							clrtobot(3XCURSES)