clrtobot or wclrtobot Subroutine

Purpose

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

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

int clrtobot(void);

int wclrtobot(WINDOW *win);

Description

The clrtobot and wclrtobot subroutines erase all lines following the cursor in the current or specified window, and erase the current line from the cursor to the end of the line, inclusive. These subroutines do not update the cursor.

Parameters

Return Values

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

Examples

1. To erase the lines below and to the right of the logical cursor in the stdscr, enter:

   clrtobot();

2. To erase the lines below and to the right of the logical cursor in the user-defined window my_window, enter:

   WINDOW *my_window;
   wclrtobot(my_window);

Implementation Specifics

These subroutines are part of Base Operating System (BOS) Runtime.

Related Information

The doupdate subroutine.

Curses Overview for Programming in AIX General Programming Concepts: Writing and Debugging Programs.

List of Curses Subroutines in AIX General Programming Concepts: Writing and Debugging Programs.

Manipulating Characters with Curses in AIX General Programming Concepts: Writing and Debugging Programs.