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 Functionsclrtoeol(3XCURSES)


NAME

 clrtoeol, wclrtoeol - clear to the end of a line

SYNOPSIS

 
#include <curses.h>
int clrtoeol(void);
 int wclrtoeol(WINDOW *win);

DESCRIPTION

 

The clrtoeol() function clears the current line from the cursor to the right margin in the stdscr window. The wclrtoeol() function performs the same action, but in the window specified by win instead of 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 in which to clear to the end of the line.

RETURN VALUES

 

On success, these functions return OK. Otherwise, they return FALSE.

ERRORS

 

None.

SEE ALSO

 

bkgdset(3XCURSES), clear(3XCURSES), clearok(3XCURSES), clrtobot(3XCURSES)


SunOS 5.9Go To TopLast Changed 1 Jun 1996

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