curs_insstr(3x) Library calls curs_insstr(3x)
insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, mvwinsstr,
mvwinsnstr - insert a string in a curses window
#include <curses.h>
int insstr(const char *str);
int insnstr(const char *str, int n);
int winsstr(WINDOW *win, const char *str);
int winsnstr(WINDOW *win, const char *str, int n);
int mvinsstr(int y, int x, const char *str);
int mvinsnstr(int y, int x, const char *str, int n);
int mvwinsstr(WINDOW *win, int y, int x, const char *str);
int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);
These routines insert a character string (as many characters as will
fit on the line) before the character under the cursor, as if calling
winsch(3x). All characters to the right of the cursor are shifted
right, with the possibility of the rightmost characters on the line
being lost. No wrapping is performed.
The cursor position does not change (after moving to y, x, if
specified).
The functions with n as the last argument insert a leading substring of
at most n characters. If n is less than zero, the entire string is
inserted (stopping on a NUL character).
Special characters are handled as in waddch(3x).
All functions return the integer ERR upon failure and OK on success.
X/Open Curses does not specify any error conditions. This
implementation returns ERR
o if the win parameter is null or
o if the str parameter is null or
o the winsch(3x) function returns ERR.
Functions prefixed with "mv" first perform cursor movement and fail if
the position (y, x) is outside the window boundaries.
All but winsnstr may be macros.
X/Open Curses, Issue 4 describes these functions. It specifies no
error conditions for them.
Issue 4 distinguished insnstr and winsnstr by stating they "do not
perform wrapping". This was probably an error, since it makes this
group of functions inconsistent. No implementation of curses documents
this inconsistency, and Issue 7 removed it.
Issue 4 states that the entire string is inserted if n is less than 1.
This is probably an error, because it is inconsistent with other
functions, and differs from the SVr4 curses and Solaris xcurses
implementations. Nevertheless, Issue 7 retains it.
curs_ins_wstr(3x) describes comparable functions of the ncurses library
in its wide-character configuration (ncursesw).
curses(3x), curs_inch(3x), curs_ins_wstr(3x), curs_util(3x)
ncurses 6.5 2024-06-08 curs_insstr(3x)