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