curs_ins_wstr(3x) — Linux manual page


curs_ins_wstr(3X)                                      curs_ins_wstr(3X)

NAME         top

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

SYNOPSIS         top

       #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         top

       These routines insert a wchar_t character string (as many charac‐
       ters as will fit on the line) before the character under the cur‐
       sor.   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  four
       routines  with  n as the last argument insert a leading substring
       of at most n wchar_t characters.  If n is less than 1, the entire
       string is inserted.

       If a character in wstr is a  tab,  newline,  carriage  return  or
       backspace,  the  cursor is moved appropriately within the window.
       A newline also does a clrtoeol before moving.  Tabs  are  consid‐
       ered to be at every eighth column.  If a character in wstr is an‐
       other control character, it is drawn in the ^X notation.  Calling
       win_wch  after  adding  a control character (and moving to it, if
       necessary) does not return the control character, but instead re‐
       turns a character in the ^-representation of the control  charac‐

NOTES         top

       Note that 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.

RETURN VALUE         top

       Upon  successful  completion,  these functions return OK.  Other‐
       wise, they return ERR.

       Functions with a “mv” prefix first perform a cursor movement  us‐
       ing  wmove,  and  return  an error if the position is outside the
       window, or if the window pointer is null.

SEE ALSO         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.   Informa‐
       tion    about    the    project    can    be    found    at    
       ⟨⟩.  If you  have
       a    bug    report   for   this   manual   page,   send   it   to  This page  was  obtained  from  the
       project's   upstream   Git   mirror   of   the   CVS   repository
       ⟨⟩ on 2024-06-14.  (At  that
       time,  the  date  of the most recent commit that was found in the
       repository  was  2023-03-12.)   If  you  discover  any  rendering
       problems  in  this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or  you  have
       corrections  or  improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a  mail  to