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=e0bd72423d5d7afa00244c5fe9f800b063721f70;hb=HEAD;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/doc/html/man/curs_addwstr.3x.html b/doc/html/man/curs_addwstr.3x.html index e0bd7242..ce3229ac 100644 --- a/doc/html/man/curs_addwstr.3x.html +++ b/doc/html/man/curs_addwstr.3x.html @@ -1,7 +1,7 @@ - - + -curs_addwstr 3x - - + + +curs_addwstr 3x 2024-04-20 ncurses 6.5 Library calls + + -

curs_addwstr 3x

-
+

curs_addwstr 3x 2024-04-20 ncurses 6.5 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 routines write the characters of the (null-terminat-
-       ed) 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 routines perform cursor movement once, before writ-
-       ing any characters.  Thereafter, the cursor is advanced 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  routines  with  n as the last argument write at
-       most n wchar_t characters.  If n is -1,  then  the  entire
-       string  will be added, up to the maximum number of charac-
-       ters that will fit on the line,  or  until  a  terminating
-       null is reached.
+       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 VALUES

-       All routines return the integer ERR upon failure and OK on
-       success.
+       ncurses(3x) describes the variants of these functions.
 
 
-
-

NOTES

-       Note that all of these routines except  waddnwstr  may  be
-       macros.
+

RETURN VALUE

+       These functions return OK on success and ERR on failure.
 
+       X/Open  Curses  does not specify any error conditions.  ncurses returns
+       an error
 
-
-

PORTABILITY

-       All  these  entry  points  are described in the XSI Curses
-       standard, Issue 4.
+       o   if the window pointer is NULL,
 
+       o   if the string pointer is NULL, or
 
-
-

SEE ALSO

-       curses(3x), curs_add_wch(3x)
+       o   if an internal wadd_wch(3x) call 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 of these functions except waddnwstr may be implemented as macros.
+
+
+

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.5                       2024-04-20                  curs_addwstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +