curs_ins_wstr.3x - Man Page

#include <curses.h>

int ins_wstr(const wchar_t *wstr);
int ins_nwstr(const wchar_t *wstr, int n);
int wins_wstr(WINDOW *win, const wchar_t *wstr);
int wins_nwstr(WINDOW *win, const wchar_t *wstr, int n);

int mvins_wstr(int y, int x, const wchar_t *wstr);
int mvins_nwstr(int y, int x, const wchar_t *wstr, int n);
int mvwins_wstr(WINDOW *win, int y, int x, const wchar_t *wstr);
int mvwins_nwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);

These routines insert a wchar_t character string (as many characters as will fit on the line) before the character under the cursor, as if calling wins_wch(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 wchar_t characters. If n is less than zero, the entire string is inserted (stopping on a L'\0' character).

Special characters are handled as in wadd_wch(3X).

These functions return OK on success and ERR on failure.

X/Open Curses does not specify any error conditions. In ncurses, they return ERR if

• win is NULL,
• wstr is NULL, or
• an internal wins_wch(3X) call returns ERR.

Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.

All of these functions except wins_nwstr may be implemented as macros.

If the first character in the string is a non-spacing character, these functions return ERR. X/Open Curses does not specify what happens if a non-spacing character follows a control character.

X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them.

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_insstr(3X) describes comparable functions of the ncurses library in its non-wide-character configuration.

curses(3X), curs_ins_wch(3X), curs_in_wch(3X)

The man pages ins_nwstr.3x(3), ins_wstr.3x(3), mvins_nwstr.3x(3), mvins_wstr.3x(3), mvwins_nwstr.3x(3), mvwins_wstr.3x(3), wins_nwstr.3x(3) and wins_wstr.3x(3) are aliases of curs_ins_wstr.3x(3).