X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insch.3x.html;h=12edc6cd880ddf9cf9c15dd9c0ef4d03455d20b5;hp=54f6b467302dc01315ab9e4e06c68961ac62b317;hb=HEAD;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_insch.3x.html b/doc/html/man/curs_insch.3x.html index 54f6b467..a29cf8ae 100644 --- a/doc/html/man/curs_insch.3x.html +++ b/doc/html/man/curs_insch.3x.html @@ -1,6 +1,7 @@ - - -curs_insch 3x - - + +curs_insch 3x 2024-04-20 ncurses 6.4 Library calls + + -

curs_insch 3x

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

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

NAME

-       insch,  winsch, mvinsch, mvwinsch - insert a character before cursor in
-       a curses window
+       insch,  winsch,  mvinsch,  mvwinsch  -  insert  a curses character in a
+       window

SYNOPSIS

        #include <curses.h>
 
-       int insch(chtype ch);
-       int winsch(WINDOW *win, chtype ch);
-       int mvinsch(int y, int x, chtype ch);
-       int mvwinsch(WINDOW *win, int y, int x, chtype ch);
+       int insch(chtype ch);
+       int winsch(WINDOW *win, chtype ch);
+       int mvinsch(int y, int x, chtype ch);
+       int mvwinsch(WINDOW *win, int y, int x, chtype ch);

DESCRIPTION

-       These routines insert the character ch before the character  under  the
-       cursor.   All characters to the right of the cursor are moved one space
-       to the right, with the possibility of the rightmost  character  on  the
-       line  being  lost.   The insertion operation does not change the cursor
-       position.
+       These functions insert the curses character ch at  the  cursor  in  the
+       specified  window  win  (or  stdscr).   The character previously at the
+       cursor and any to its right move one cell to the right;  the  rightmost
+       character on the line is discarded.  The cursor does not advance.

RETURN VALUE

-       All routines that return an integer return  ERR  upon  failure  and  OK
-       (SVr4 specifies only "an integer value other than ERR") upon successful
-       completion, unless otherwise noted in the  preceding  routine  descrip-
-       tions.
+       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

-       These  routines do not necessarily imply use of a hardware insert char-
-       acter feature.
+       insch, mvinsch, and mvwinsch may be implemented as macros.
 
-       Note that insch, mvinsch, and mvwinsch may be macros.
+       A terminal's insert_character  (ich1)  capability  is  not  necessarily
+       employed.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       X/Open Curses, Issue 4 describes these functions.
+
+       SVr4  curses  describes  a  successful return value only as "an integer
+       value other than ERR".