X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_add_wchstr.3x.html;h=b99571217adcb213401d215f9105b421f4fc2847;hp=8b4fe83d8b2f4e08a13bc8c9914326cb3ea68d92;hb=HEAD;hpb=d97989d1e0db7282c723cabb44b991b951790006 diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index 8b4fe83d..f554061d 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -1,6 +1,7 @@ - -curs_add_wchstr 3x +curs_add_wchstr 3x 2024-04-20 ncurses 6.5 Library calls - + -

curs_add_wchstr 3x

curs_add_wchstr 3x 2024-04-20 ncurses 6.5 Library calls

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

NAME

-       add_wchstr, add_wchnstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr,
-       mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - add an array of complex
-       characters (and attributes) to a curses window
+       add_wchstr,   add_wchnstr,   wadd_wchstr,  wadd_wchnstr,  mvadd_wchstr,
+       mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr -  add  a  curses  complex
+       character string to a window

SYNOPSIS

        #include <curses.h>
 
        int add_wchstr(const cchar_t *wchstr);
-       int add_wchnstr(const cchar_t *wchstr, int n);
        int wadd_wchstr(WINDOW * win, const cchar_t *wchstr);
-       int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
        int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
-       int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
        int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);
+
+       int add_wchnstr(const cchar_t *wchstr, int n);
+       int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
+       int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
        int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n);

DESCRIPTION

        These  functions copy the (null-terminated) array of complex characters
        wchstr into the window image structure starting at the  current  cursor
-       position.   The four functions with n as the last argument copy at most
-       n elements, but no more than will fit on the line.  If  n=-1  then  the
-       whole  array  is  copied, to the maximum number of characters that will
-       fit on the line.
+       position.
+
+       The four functions with n as the last argument copy at most n elements,
+       but no more than will fit on the line.  If n=-1 then the whole array is
+       copied, to the maximum number of characters that will fit on the line.
 
-       The window cursor is not advanced.  These functions  work  faster  than
+       The  window  cursor  is  not advanced.  These functions are faster than
        waddnstr.  On the other hand:
 
-       o   they  do  not perform checking (such as for the newline, backspace,
+       o   they do not perform checking (such as for the  newline,  backspace,
            or carriage return characters),
 
        o   they do not advance the current cursor position,
 
        o   they do not expand other control characters to ^-escapes, and
 
-       o   they truncate the string if it crosses  the  right  margin,  rather
+       o   they  truncate  the  string  if it crosses the right margin, rather
            than wrapping it around to the new line.
 
-       These  functions  end  successfully  on encountering a null cchar_t, or
-       when they have filled the current line.  If a complex character  cannot
-       completely  fit  at  the end of the current line, the remaining columns
+       These functions end successfully on encountering  a  null  cchar_t,  or
+       when  they have filled the current line.  If a complex character cannot
+       completely fit at the end of the current line,  the  remaining  columns
        are filled with the background character and rendition.

RETURN VALUE

        All functions return the integer ERR upon failure and OK on success.
 
-       X/Open does not define any error conditions.  This  implementation  re-
-       turns an error if the window pointer is null.
+       X/Open   Curses   does   not   specify   any  error  conditions.   This
+       implementation returns an error
+
+       o   if the win parameter is null or
+
+       o   if the wchstr parameter is null.
 
-       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

@@ -107,18 +113,18 @@

PORTABILITY

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