X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addwstr.3x.html;h=5285206982e5e7484bf41aa81a382068d806602c;hp=d10a23e7c8274b6858e5382eec25f3e9b7fdac79;hb=HEAD;hpb=06078d3fa68db669ed37178c01873546b4b28745 diff --git a/doc/html/man/curs_addwstr.3x.html b/doc/html/man/curs_addwstr.3x.html index d10a23e7..28199cc2 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-20 ncurses 6.4 Library calls + + -

curs_addwstr 3x

curs_addwstr 3x 2024-04-20 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
+       addwstr,   addnwstr,   waddwstr,   waddnwstr,   mvaddwstr,  mvaddnwstr,
+       mvwaddwstr, mvwaddnwstr - add  a  wide-character  string  to  a  curses
+       window and advance the cursor

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-terminated) wchar_t
-       character string wstr on the given window.  It is similar to construct-
-       ing a cchar_t for each wchar_t in the string, then calling wadd_wch for
-       the resulting cchar_t.
+       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 char-
-       acters.  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 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.
+
+       ncurses(3x) describes the variants of these functions.

RETURN VALUE

-       All functions return the integer ERR upon failure and OK on success.
+       These functions return OK on success and ERR on failure.
 
-       X/Open does not define any error conditions.  This  implementation  re-
-       turns an error
+       X/Open  Curses  does not specify any error conditions.  ncurses returns
+       an error
 
-       o   if the window pointer is null or
+       o   if the window pointer is NULL,
 
-       o   if the string pointer is null or
+       o   if the string pointer is NULL, or
 
-       o   if the corresponding calls to wadd_wch return an error.
+       o   if an internal wadd_wch(3x) call returns an error.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       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 macros.
+       All of these functions except waddnwstr may be implemented as macros.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       X/Open Curses, Issue 4 describes these functions.