# curs_ins_wstr 3x 2024-04-20 ncurses 6.5 Library calls

    curs_ins_wstr(3x)                Library calls               curs_ins_wstr(3x)

## NAME

           ins_wstr,  ins_nwstr,  wins_wstr,  wins_nwstr, mvins_wstr, mvins_nwstr,
           mvwins_wstr, mvwins_nwstr - insert a wide-character string in a  curses
           window

## SYNOPSIS

           #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);

## DESCRIPTION

           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).

## RETURN VALUE

           All functions return the integer ERR upon failure and OK on success.

           X/Open  Curses  does  not   specify   any   error   conditions.    This
           implementation returns an error

           o   if the win parameter is null or

           o   if the wstr parameter is null or

           o   if the wins_wch function returns an error.

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

## NOTES

           All but wins_nwstr may be macros.

           If the first character in the string is a non-spacing character,  these
           functions will fail.  X/Open Curses does not define what will happen if
           a non-spacing character follows a control character.

## PORTABILITY

           These functions are described in X/Open Curses,  Issue  4,  which  adds
           const qualifiers to the arguments.

           X/Open  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 X/Open implementation on Solaris.

## SEE ALSO

           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)

    ncurses 6.5                       2024-04-20                 curs_ins_wstr(3x)