Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / 9b9f5e71c18a5d2317f7871a472b47d3d7efc0c4 / . / doc / html / man / curs_addstr.3x.html
blob: b7f1c689b9949f2f2e8c1eb248c5e38961db8bd1 [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]1<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]2 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]3 * Copyright 2019-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2012,2017 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]5 * *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
28 * authorization. *
29 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]30 * @Id: curs_addstr.3x,v 1.45 2024/04/20 19:18:18 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>curs_addstr 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]40</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]42<H1 class="no-header">curs_addstr 3x 2024-04-20 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]44<STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>addstr</STRONG>, <STRONG>addnstr</STRONG>, <STRONG>waddstr</STRONG>, <STRONG>waddnstr</STRONG>, <STRONG>mvaddstr</STRONG>, <STRONG>mvaddnstr</STRONG>, <STRONG>mvwaddstr</STRONG>,
51 <STRONG>mvwaddnstr</STRONG> - add a string to a <EM>curses</EM> window and advance the cursor
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52
53
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57 <STRONG>int</STRONG> <STRONG>addstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]58 <STRONG>int</STRONG> <STRONG>mvaddstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]59 <STRONG>int</STRONG> <STRONG>mvwaddstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]60 <STRONG>int</STRONG> <STRONG>waddstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
61
62 <STRONG>int</STRONG> <STRONG>addnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvaddnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvwaddnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>waddnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]66
67
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]68</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 <STRONG>waddstr</STRONG> writes the characters of the (null-terminated) string <EM>str</EM> to
70 the window <EM>win</EM>. Its process is similar to calling <STRONG><A HREF="curs_addch.3x.html">waddch(3x)</A></STRONG> for each
71 <EM>char</EM> in <EM>str</EM>. Control characters are processed as in <STRONG><A HREF="curs_addch.3x.html">waddch(3x)</A></STRONG>.
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]72
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]73 <STRONG>waddnstr</STRONG> writes at most <EM>n</EM> characters, or until a terminating null
74 character occurs in <EM>str</EM>. If <EM>n</EM> is -1, <STRONG>waddnstr</STRONG> writes the entire
75 string.
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]76
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]77 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of these functions.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]78
79
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]80</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
81 These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]82
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]83 X/Open Curses does not specify any error conditions. <EM>ncurses</EM> returns
84 an error
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]85
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]86 <STRONG>o</STRONG> if the window pointer is <STRONG>NULL</STRONG>,
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]87
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]88 <STRONG>o</STRONG> if the string pointer is <STRONG>NULL</STRONG>, or
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]89
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]90 <STRONG>o</STRONG> if an internal <STRONG><A HREF="curs_addch.3x.html">waddch(3x)</A></STRONG> call returns an error.
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]91
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]92 Functions prefixed with "mv" first perform cursor movement and fail if
93 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]94
95
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]96</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]97 All of these functions except <STRONG>waddnstr</STRONG> may be macros.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]98
99
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]100</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
101 X/Open Curses, Issue 4 describes these functions.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]102
103
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]104</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
105 <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> library
106 in its wide-character configuration (<EM>ncursesw</EM>).
107
108 <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_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]109
110
111
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]112ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]113</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]114<div class="nav">
115<ul>
116<li><a href="#h2-NAME">NAME</a></li>
117<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
118<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
119<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
120<li><a href="#h2-NOTES">NOTES</a></li>
121<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123</ul>
124</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]125</BODY>
126</HTML>