ncurses 5.9 - patch 20130309
[ncurses.git] / doc / html / man / curs_add_wchstr.3x.html
index e4d7e47f9ff5b52ab381a7443be8bfbadd96410d..c69f003c4f3363d991bbc9027490e22cd818f3c9 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2002-2005,2010 Free Software Foundation, Inc.              *
+  * Copyright (c) 2002-2010,2012 Free Software Foundation, Inc.              *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -27,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_add_wchstr.3x,v 1.8 2010/08/14 23:29:16 tom Exp @
+  * @Id: curs_add_wchstr.3x,v 1.10 2012/11/03 22:54:43 tom Exp @
 -->
 <HTML>
 <HEAD>
@@ -47,7 +47,7 @@
 
 </PRE>
 <H2>NAME</H2><PRE>
-       <STRONG>add_wchstr</STRONG>,    <STRONG>add_wchnstr</STRONG>,   <STRONG>wadd_wchstr</STRONG>,   <STRONG>wadd_wchnstr</STRONG>,
+       <STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>,
        <STRONG>mvadd_wchstr</STRONG>, <STRONG>mvadd_wchnstr</STRONG>, <STRONG>mvwadd_wchstr</STRONG>, <STRONG>mvwadd_wchnstr</STRONG>
        - add an array of complex characters (and attributes) to a
        curses window
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
-       These routines copy the array of complex characters <EM>wchstr</EM>
-       into  the  window image structure at and after the current
-       cursor position.  The four routines with  <EM>n</EM>  as  the  last
-       argument  copy  at  most <EM>n</EM> elements, but no more than will
-       fit on the line.  If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the whole array is  copied,
-       to  the  maximum number of characters that will fit on the
-       line.
-
-       The window cursor is <EM>not</EM> advanced.   These  routines  work
-       faster than <STRONG>waddnstr</STRONG>.  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 than wrapping  it  around
-       to the new line.
-
-       These  routines  end  successfully  on encountering a null
-       <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM>, 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.
+       These functions copy the (null-terminated) array  of  com-
+       plex  characters  <EM>wchstr</EM>  into  the window image structure
+       starting at the current cursor position.  The  four  func-
+       tions with <EM>n</EM> as the last argument copy at most <EM>n</EM> elements,
+       but no more than will fit on the line.  If <STRONG>n</STRONG>=<STRONG>-1</STRONG>  then  the
+       whole array is copied, to the maximum number of characters
+       that will fit on the line.
 
+       The window cursor is <EM>not</EM> advanced.  These  functions  work
+       faster than <STRONG>waddnstr</STRONG>.  On the other hand:
 
-</PRE>
-<H2>NOTES</H2><PRE>
-       All functions except <STRONG>wadd_wchnstr</STRONG> may be macros.
+       <STRONG>o</STRONG>   they do not perform checking (such as for the newline,
+           backspace, or carriage return characters),
+
+       <STRONG>o</STRONG>   they do not advance the current cursor position,
+
+       <STRONG>o</STRONG>   they do not expand other control characters  to  ^-es-
+           capes, and
+
+       <STRONG>o</STRONG>   they  truncate the string if it crosses the right mar-
+           gin, rather than wrapping it around to the new line.
+
+       These functions end successfully on  encountering  a  null
+       <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM>,  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.
 
 
 </PRE>
-<H2>RETURN VALUES</H2><PRE>
-       All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
-       success.
+<H2>RETURN VALUE</H2><PRE>
+       All functions return the integer <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>
+       on success.
+
+       X/Open  does not define any error conditions.  This imple-
+       mentation returns an error if the window pointer is null.
 
        Functions with a "mv" prefix first perform a cursor  move-
        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
        outside the window, or if the window pointer is null.
 
 
+</PRE>
+<H2>NOTES</H2><PRE>
+       All functions except <STRONG>wadd_wchnstr</STRONG> may be macros.
+
+
 </PRE>
 <H2>PORTABILITY</H2><PRE>
-       All these entry points are described  in  the  XSI  Curses
-       standard, Issue 4.
+       These entry points are described in the XSI  Curses  stan-
+       dard, Issue 4.
 
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>, <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
+       <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
+
+       Comparable functions in the narrow-character (ncurses) li-
+       brary are described in <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>.