Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
X/Open Curses Library Functionsclrtobot(3XCURSES)


NAME

 clrtobot, wclrtobot - clear to the end of a window

SYNOPSIS

 
#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 performs 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.

SEE ALSO

 

bkgdset(3XCURSES), clear(3XCURSES), clearok(3XCURSES), crltoeol(3xcurses)


SunOS 5.9Go To TopLast Changed 1 Jun 1996

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.