curs_insstr.3x - Man Page

#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

• if the win parameter is null or
• if the str parameter is null or
• 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)

The man pages insnstr.3x(3), insstr.3x(3), mvinsnstr.3x(3), mvinsstr.3x(3), mvwinsnstr.3x(3), mvwinsstr.3x(3), winsnstr.3x(3) and winsstr.3x(3) are aliases of curs_insstr.3x(3).