X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_delch.3x.html;h=d8fcfde0e9e084ea0fe54dcb7e511d5ad9f636da;hb=00dd248b527ad47f0fc3b0776a0889da0ac926d0;hp=17698ec5574edd95c823084dd19217bddd358b83;hpb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;p=ncurses.git diff --git a/doc/html/man/curs_delch.3x.html b/doc/html/man/curs_delch.3x.html index 17698ec5..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

@@ -61,32 +61,37 @@

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
-       specified).  (This does not imply use of the hardware delete  character
-       feature.)
+       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
-       specifies only "an integer  value  other  than  ERR")  upon  successful
-       completion.
+       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".