X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_delch.3x.html;h=541f0ce49d4d4ef784a7ff74f7acf2dc80692f73;hb=HEAD;hp=97ed949aa6bb9f7d60cb035e7eed4e04ab772a4f;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b;p=ncurses.git diff --git a/doc/html/man/curs_delch.3x.html b/doc/html/man/curs_delch.3x.html index 97ed949a..5196e418 100644 --- a/doc/html/man/curs_delch.3x.html +++ b/doc/html/man/curs_delch.3x.html @@ -1,6 +1,7 @@ -
--curs_delch(3x) curs_delch(3x) +curs_delch(3x) Library calls curs_delch(3x)
- delch, wdelch, mvdelch, mvwdelch - delete character under the cursor in - a curses window + delch, wdelch, mvdelch, mvwdelch - delete a character from a curses + window
#include <curses.h> int delch(void); - int wdelch(WINDOW *win); - int mvdelch(int y, int x); - int mvwdelch(WINDOW *win, int y, int x); + int wdelch(WINDOW *win); + int mvdelch(int y, int x); + int mvwdelch(WINDOW *win, int y, int x);
- These routines delete the character under the cursor; all characters to - the right of the cursor on the same line are moved to the left one - position and the last character on the line is filled with a blank. - The cursor position does not change (after moving to y, x, if speci- - fied). (This does not imply use of the hardware delete character fea- - ture.) + wdelch deletes the character at the cursor position in win. It moves + all characters to the right of the cursor on the same line to the left + one position and replaces the contents of the rightmost position on the + line with the window's blank character; see bkgd(3x) (wide-character + API users: bkgrnd(3x)). The cursor position does not change (after + moving to (y, x), if specified). ncurses(3x) describes the variants of + this function.
- All routines return the integer ERR upon failure and an OK (SVr4 speci- - fies only "an integer value other than ERR") upon successful comple- - tion. + These functions return OK on success and ERR on failure. + + Functions taking a WINDOW pointer argument fail if the pointer is NULL. - Functions with a "mv" prefix first perform a cursor movement using - wmove, and return an error if the position is outside the window, or if - the window pointer is null. + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries.
- Note that delch, mvdelch, and mvwdelch may be macros. + delch, mvdelch, and mvwdelch may be implemented as macros. + + A terminal's delete_character (dch1) capability is not necessarily + employed.
- These functions are described in the XSI Curses standard, Issue 4. The - standard specifies that they return ERR on failure, but specifies no - error conditions. + X/Open Curses, Issue 4 describes these functions. It specifies no + error conditions for them. + + SVr4 curses describes a successful return value only as "an integer + value other than ERR".
@@ -93,7 +99,7 @@ - curs_delch(3x) +ncurses 6.5 2024-05-11 curs_delch(3x)