]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_addchstr.3x.html
ncurses 6.4 - patch 20231118
[ncurses.git] / doc / html / man / curs_addchstr.3x.html
index d1b8b8af48fedd595bff6560aa42682b57e627b1..35908da896e1f0aa4cb8df5f1f8650ee0772261c 100644 (file)
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_addchstr.3x,v 1.34 2023/10/07 21:19:07 tom Exp @
+  * @Id: curs_addchstr.3x,v 1.36 2023/11/18 21:18:55 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_addchstr 3x 2023-10-07 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_addchstr 3x 2023-11-18 ncurses 6.4 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_addchstr 3x 2023-10-07 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_addchstr 3x 2023-11-18 ncurses 6.4 Library calls</H1>
 <PRE>
 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>                Library calls               <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        These functions copy the (null-terminated) <EM>chstr</EM> array into the  window
-       image  structure  starting  at  the  current cursor position.  The four
-       functions 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
+       image structure starting at the current cursor position.
+
+       The four functions 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
+       The  window  cursor  is  <EM>not</EM> advanced.  These functions are faster than
        <STRONG>waddnstr</STRONG>.  On the other hand:
 
-       <STRONG>o</STRONG>   they  do  not perform checking (such as for the newline, backspace,
+       <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 ^-escapes, and
 
-       <STRONG>o</STRONG>   they truncate the string if it crosses  the  right  margin,  rather
+       <STRONG>o</STRONG>   they  truncate  the  string  if it crosses the right margin, rather
            than wrapping it around to the new line.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></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 implementation
-       returns an error if the window pointer is null.
+       X/Open does not  define  any  error  conditions.   This  implementation
+       returns an error
+
+       <STRONG>o</STRONG>   if the <EM>win</EM> parameter is null or
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
+       <STRONG>o</STRONG>   if the <EM>wchstr</EM> parameter is null.
+
+       Functions  with  a  "mv"  prefix  first perform a cursor movement using
        <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
        the window pointer is null.
 
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
-
-       Comparable functions  in  the  wide-character  (ncursesw)  library  are
-       described in <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,    <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>,    <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>,    <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>,
+       <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
 
 
 
-ncurses 6.4                       2023-10-07                 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
+ncurses 6.4                       2023-11-18                 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>