e83e795f01fd65db5191e3dc3b944fca0bd6866d
[ncurses.git] / doc / html / man / curs_addstr.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>addstr</B>,  <B>addnstr</B>,  <B>waddstr</B>, <B>waddnstr</B>, <B>mvaddstr</B>, <B>mvaddnstr</B>,
9        <B>mvwaddstr</B>, <B>mvwaddnstr</B> - add a string of  characters  to  a
10        <B>curses</B> window and advance cursor
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>addstr(const</B> <B>char</B> <B>*str);</B>
18        <B>int</B> <B>addnstr(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
19        <B>int</B> <B>waddstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str);</B>
20        <B>int</B> <B>waddnstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
21        <B>int</B> <B>mvaddstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B>
22        <B>int</B> <B>mvaddnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
23        <B>int</B> <B>mvwaddstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B>
24        <B>int</B> <B>mvwaddnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B>
25        <B>int</B> <B>n);</B>
26
27
28 </PRE>
29 <H2>DESCRIPTION</H2><PRE>
30        These  routines  write  the characters of the (null-termi-
31        nated) character string <I>str</I> on the given  window.   It  is
32        similar  to  calling <B>waddch</B> once for each character in the
33        string.  The four routines with <I>n</I>  as  the  last  argument
34        write  at  most <I>n</I> characters.  If <I>n</I> is -1, then the entire
35        string will be added.
36
37
38 </PRE>
39 <H2>RETURN VALUE</H2><PRE>
40        All routines return the integer <B>ERR</B> upon failure and <B>OK</B> on
41        success  (the  SVr4 manuals specify only "an integer value
42        other than <B>ERR</B>") upon successful completion.
43
44
45 </PRE>
46 <H2>NOTES</H2><PRE>
47        Note  that  all  of  these  routines  except  <B>waddstr</B>  and
48        <B>waddnstr</B> may be macros.
49
50
51 </PRE>
52 <H2>PORTABILITY</H2><PRE>
53        All  these  entry  points  are described in the XSI Curses
54        standard, Issue 4.  The XSI errors EILSEQ  and  EOVERFLOW,
55        associated  with  extended-level  conformance, are not yet
56        detected.
57
58
59 </PRE>
60 <H2>SEE ALSO</H2><PRE>
61        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>.
62
63
64
65
66
67
68
69
70
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>