curs_ins_wstr 3x 2023-11-25 ncurses 6.4 Library calls

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


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


       #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

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


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

       X/Open does not  define  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  with  a  "mv"  prefix  first perform a cursor movement using
       wmove(3x), and return an error if the position is outside  the  window,
       or if the window pointer is null.


       All but wins_nwstr may be macros.

       If  the  first character in the string is a nonspacing character, these
       functions will fail.  XSI  does  not  define  what  will  happen  if  a
       nonspacing character follows a control character.


       These  functions  are  described  in  the XSI Curses standard, 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.


       curses(3x), curs_insstr(3x), curs_ins_wch(3x), curs_in_wch(3x)

ncurses 6.4                       2023-11-25                 curs_ins_wstr(3x)