X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_delch.3x.html;h=541f0ce49d4d4ef784a7ff74f7acf2dc80692f73;hp=341efbfb65578a2d7a9f3d63b0a63955aa73d089;hb=HEAD;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045 diff --git a/doc/html/man/curs_delch.3x.html b/doc/html/man/curs_delch.3x.html index 341efbfb..d8fcfde0 100644 --- a/doc/html/man/curs_delch.3x.html +++ b/doc/html/man/curs_delch.3x.html @@ -1,6 +1,6 @@ - -curs_delch 3x +curs_delch 3x 2024-04-20 ncurses 6.4 Library calls - + -

curs_delch 3x

curs_delch 3x 2024-04-20 ncurses 6.4 Library calls

-curs_delch(3x)                                                  curs_delch(3x)
+curs_delch(3x)                   Library calls                  curs_delch(3x)

NAME

-       delch, wdelch, mvdelch, mvwdelch - delete character under the cursor in
-       a curses window
+       delch,  wdelch,  mvdelch,  mvwdelch  - delete a character from a curses
+       window

SYNOPSIS

        #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);

DESCRIPTION

-       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.
+       ncurses(3x) describes the variants of this function.
+
+       wdelch 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 may consult bkgrnd(3x) instead).  The  cursor
+       position does not change (after moving to (y, x), if specified).

RETURN VALUE

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

NOTES

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

PORTABILITY

-       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.
+
+       SVr4  curses  describes  a  successful return value only as "an integer
+       value other than ERR".