ncurses 5.1
[ncurses.git] / doc / html / man / curs_addchstr.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>addchstr</B>,  <B>addchnstr</B>,  <B>waddchstr</B>,  <B>waddchnstr</B>, <B>mvaddchstr</B>,
9        <B>mvaddchnstr</B>, <B>mvwaddchstr</B>, <B>mvwaddchnstr</B> - add a  string  of
10        characters (and attributes) to a <B>curses</B> window
11
12
13 </PRE>
14 <H2>SYNOPSIS</H2><PRE>
15        <B>#include</B> <B>&lt;curses.h&gt;</B>
16
17        <B>int</B> <B>addchstr(const</B> <B>chtype</B> <B>*chstr);</B>
18        <B>int</B> <B>addchnstr(const</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
19        <B>int</B> <B>waddchstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>*chstr);</B>
20        <B>int</B> <B>waddchnstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
21        <B>int</B> <B>mvaddchstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B> <B>*chstr);</B>
22        <B>int</B> <B>mvaddchnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
23        <B>int</B> <B>mvwaddchstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B>  <B>x,</B>  <B>const</B>  <B>chtype</B>
24        <B>*chstr);</B>
25        <B>int</B>  <B>mvwaddchnstr(WINDOW</B>  <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>chtype</B>
26        <B>*chstr,</B> <B>int</B> <B>n);</B>
27
28
29 </PRE>
30 <H2>DESCRIPTION</H2><PRE>
31        These routines copy <I>chstr</I> into the window image  structure
32        at  and  after the current cursor position.  The four rou-
33        tines with <I>n</I> as the last argument copy at most <I>n</I> elements,
34        but  no  more than will fit on the line.  If <B>n</B>=<B>-1</B> then the
35        whole string is copied, to the maximum number  of  charac-
36        ters that will fit on the line.
37
38        The window cursor is <I>not</I> advanced, and these routines work
39        faster than <B>waddnstr</B>.  On the other hand, they don't  per-
40        form  any  kind  of  checking  (such  as  for the newline,
41        backspace, or  carriage  return  characters),  they  don't
42        advance  the  current  cursor  position, they don't expand
43        other control characters to ^-escapes, and  they  truncate
44        the  string  if  it  crosses the right margin, rather then
45        wrapping it around to the new line.
46
47
48
49 </PRE>
50 <H2>RETURN VALUES</H2><PRE>
51        All routines return the integer <B>ERR</B> upon failure and <B>OK</B> on
52        success  (the  SVr4 manuals specify only "an integer value
53        other than <B>ERR</B>") upon successful completion, unless other-
54        wise noted in the preceding routine descriptions.
55
56
57 </PRE>
58 <H2>NOTES</H2><PRE>
59        Note that all routines except <B>waddchnstr</B> may be macros.
60
61
62 </PRE>
63 <H2>PORTABILITY</H2><PRE>
64        All  these  entry  points  are described in the XSI Curses
65        standard, Issue 4.
66
67
68 </PRE>
69 <H2>SEE ALSO</H2><PRE>
70        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>.
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>