clrtoeol or wclrtoeol Subroutine

Purpose

Erases the current line from the logical cursor position to the end of the line.

Library

Curses Library (libcurses.a)

Syntax

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

Description

The clrtoeol and wclrtoeol subroutines erase the current line from the cursor to the end of the line, inclusive, in the current or specified window. These subroutines do not update the cursor.

Parameters

Item Description
*win Specifies the window in which to clear the line.

Return Values

Upon successful completion, these subroutines return OK. Otherwise, they return ERR.

Examples

  1. To clear the line to the right of the logical cursor in the stdscr, enter: 
    clrtoeol();
  2. To clear the line to the right of the logical cursor in the user-defined window my_window, enter: 
    WINDOW *my_window;
wclrtoeol(my_window);