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=343a69b80a60731bea2667ea4fba4a62731dd487;hb=HEAD;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index 343a69b8..aa3ebaf5 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -1,7 +1,7 @@ - - + -curs_add_wchstr 3x - - + + +curs_add_wchstr 3x 2024-04-20 ncurses 6.4 Library calls + + -

curs_add_wchstr 3x

-
+

curs_add_wchstr 3x 2024-04-20 ncurses 6.4 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
+

NAME

+       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

+

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 routines copy the array of complex characters wchstr
-       into  the  window image structure at and after the current
-       cursor position.  The four routines 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  routines  work
-       faster than waddnstr.  On the other hand, they do not per-
-       form checking (such as for the newline, backspace, or car-
-       riage  return characters), they do not advance the current
-       cursor position, they do not expand other control  charac-
-       ters  to  ^-escapes,  and  they  truncate the string if it
-       crosses the right margin, rather then wrapping  it  around
-       to the new line.
-
-       These  routines  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.
+

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

NOTES

-       All functions except wadd_wchnstr may be macros.
+       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,
+           or carriage return characters),
 
-
-

RETURN VALUES

-       All routines return the integer ERR upon failure and OK on
-       success.
+       o   they do not advance the current cursor position,
 
+       o   they do not expand other control characters to ^-escapes, and
 
-
-

PORTABILITY

-       All these entry points are described  in  the  XSI  Curses
-       standard, Issue 4.
+       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
+       are filled with the background character and rendition.
 
-
-

SEE ALSO

-       curses(3x), curs_addchstr(3x) curs_addwstr(3x)
+
+

RETURN VALUE

+       All functions return the integer ERR upon failure and OK on success.
+
+       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 prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

+       All functions except wadd_wchnstr may be macros.
+
+
+

PORTABILITY

+       These functions are described in X/Open Curses, Issue 4.
+
+
+

SEE ALSO

+       curs_addchstr(3x) describes comparable functions of the ncurses library
+       in its non-wide-character configuration.
+
+       curses(3x), curs_addwstr(3x), curs_add_wch(3x)
 
 
 
-                                              curs_add_wchstr(3x)
+ncurses 6.4                       2024-04-20               curs_add_wchstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +