X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addwstr.3x.html;h=f157a29674d51bfe47cfb7df3723b84687f5804e;hp=c24cfa2bfecb2d5447198064b54a207fc962bdaa;hb=HEAD;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86 diff --git a/doc/html/man/curs_addwstr.3x.html b/doc/html/man/curs_addwstr.3x.html index c24cfa2b..9cc8cd0a 100644 --- a/doc/html/man/curs_addwstr.3x.html +++ b/doc/html/man/curs_addwstr.3x.html @@ -1,6 +1,7 @@ - - -curs_addwstr 3x - - + +curs_addwstr 3x 2024-04-13 ncurses 6.4 Library calls + + -

curs_addwstr 3x

+

curs_addwstr 3x 2024-04-13 ncurses 6.4 Library calls

-curs_addwstr(3x)                                       curs_addwstr(3x)
+curs_addwstr(3x)                 Library calls                curs_addwstr(3x)
 
 
 
 
-
-

NAME

-       addwstr, addnwstr, waddwstr, waddnwstr, mvaddwstr,
-       mvaddnwstr, mvwaddwstr, mvwaddnwstr - add a string of wide
-       characters to a curses window and advance cursor
+

NAME

+       addwstr,   addnwstr,   waddwstr,   waddnwstr,   mvaddwstr,  mvaddnwstr,
+       mvwaddwstr, mvwaddnwstr - add  a  wide-character  string  to  a  curses
+       window and advance the cursor
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
        int addwstr(const wchar_t *wstr);
-       int addnwstr(const wchar_t *wstr, int n);
-       int waddwstr(WINDOW *win, const wchar_t *wstr);
-       int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);
        int mvaddwstr(int y, int x, const wchar_t *wstr);
-       int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);
        int mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr);
+       int waddwstr(WINDOW *win, const wchar_t *wstr);
+
+       int addnwstr(const wchar_t *wstr, int n);
+       int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);
        int mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);
+       int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);
 
 
-
-

DESCRIPTION

-       These  functions  write the characters of the (null-termi-
-       nated) wchar_t character string wstr on the given  window.
-       It  is  similar to constructing a cchar_t for each wchar_t
-       in the string, then calling  wadd_wch  for  the  resulting
-       cchar_t.
+

DESCRIPTION

+       waddwstr  writes  the  characters  of  the (wide-null-terminated) wide-
+       character string wstr to the window win.  Its  process  is  similar  to
+       constructing   a  cchar_t  for  each  wchar_t  in  wstr,  then  calling
+       wadd_wch(3x) with the resulting cchar_t.
 
-       The  mv  functions  perform  cursor  movement once, before
-       writing any characters.  Thereafter,  the  cursor  is  ad-
-       vanced as a side-effect of writing to the window.
+       o   Spacing and non-spacing characters in the string are processed  one
+           at a time, and
 
-       The  four  functions  with n as the last argument write at
-       most n wchar_t characters, or until a terminating null  is
-       reached.   If  n  is  -1,  then  the entire string will be
-       added.
+       o   control characters are processed as in wadd_wch(3x).
 
+       waddnwstr writes at most n wide characters, or until a terminating wide
+       null character occurs in wstr.  If n is -1, waddnwstr writes the entire
+       wide string.
 
-
-

RETURN VALUE

-       All functions return the integer ERR upon failure  and  OK
-       on success.
+       ncurses(3x) describes the variants of these functions.
 
-       X/Open  does not define any error conditions.  This imple-
-       mentation returns an error
 
-       o   if the window pointer is null or
+

RETURN VALUE

+       These functions return OK on success and ERR on failure.
 
-       o   if the string pointer is null or
+       X/Open  Curses  does not specify any error conditions.  ncurses returns
+       an error
 
-       o   if the corresponding calls to wadd_wch return  an  er-
-           ror.
+       o   if the window pointer is NULL,
 
-       Functions  with a "mv" prefix first perform a cursor move-
-       ment using wmove, and return an error if the  position  is
-       outside the window, or if the window pointer is null.
+       o   if the string pointer is NULL, or
 
+       o   if an internal wadd_wch(3x) call returns an error.
 
-
-

NOTES

-       All of these functions except waddnwstr may be macros.
+       Functions with a  "mv"  prefix  first  perform  cursor  movement  using
+       wmove(3x) and fail if the position is outside the window, or (for "mvw"
+       functions) if the WINDOW pointer is null.
 
 
-
-

PORTABILITY

-       These  functions are described in the XSI Curses standard,
-       Issue 4.
+

NOTES

+       All of these functions except waddnwstr may be implemented as macros.
 
 
-
-

SEE ALSO

-       curses(3x), curs_add_wch(3x)
+

PORTABILITY

+       X/Open Curses, Issue 4 describes these functions.
+
+
+

SEE ALSO

+       curs_addstr(3x) describes comparable functions of the  ncurses  library
+       in its non-wide-character configuration.
+
+       curses(3x), curs_add_wch(3x), curs_add_wchstr(3x)
 
 
 
-                                                       curs_addwstr(3x)
+ncurses 6.4                       2024-04-13                  curs_addwstr(3x)