Debian Codegraph @

upstream/debian-trixie/man3/addstr.3ncurses

raw
1 .\"***************************************************************************
2 .\" Copyright 2019-2024,2025 Thomas E. Dickey *
3 .\" Copyright 1998-2012,2017 Free Software Foundation, Inc. *
4 .\" *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
12 .\" *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
15 .\" *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 .\" *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
27 .\" authorization. *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_addstr.3x,v 1.67 2025/02/01 22:48:11 tom Exp $
31 .TH addstr 3NCURSES 2025-02-01 "ncurses 6.5" "Library calls"
32 .ie \n(.g \{\
33 .ds `` \(lq
34 .ds '' \(rq
35 .\}
36 .el \{\
37 .ie t .ds `` ``
38 .el .ds `` ""
39 .ie t .ds '' ''
40 .el .ds '' ""
41 .\}
42 .
43 .de bP
44 .ie n .IP \(bu 4
45 .el .IP \(bu 2
46 ..
47 .SH NAME
48 \fB\%addstr\fP,
49 \fB\%waddstr\fP,
50 \fB\%mvaddstr\fP,
51 \fB\%mvwaddstr\fP,
52 \fB\%addnstr\fP,
53 \fB\%waddnstr\fP,
54 \fB\%mvaddnstr\fP,
55 \fB\%mvwaddnstr\fP \-
56 add a string to a \fIcurses\fR window and advance the cursor
57 .SH SYNOPSIS
58 .nf
59 \fB#include <curses.h>
60 .PP
61 \fBint addstr(const char * \fIstr\fP);
62 \fBint waddstr(WINDOW * \fIwin\fP, const char * \fIstr\fP);
63 \fBint mvaddstr(int \fIy\fP, int \fIx\fP, const char * \fIstr\fP);
64 \fBint mvwaddstr(WINDOW * \fIwin\fP, int \fIy\fP, int \fIx\fP, const char * \fIstr\fP);
65 .PP
66 \fBint addnstr(const char * \fIstr\fP, int \fIn\fP);
67 \fBint waddnstr(WINDOW * \fIwin\fP, const char * \fIstr\fP, int \fIn\fP);
68 \fBint mvaddnstr(int \fIy\fP, int \fIx\fP, const char * \fIstr\fP, int \fIn\fP);
69 \fBint mvwaddnstr(WINDOW * \fIwin\fP, int \fIy\fP, int \fIx\fP, const char * \fIstr\fP,
70 int \fIn\fP);
71 .fi
72 .SH DESCRIPTION
73 .B \%waddstr
74 writes the characters of the (null-terminated) string
75 .I str
76 to the window
77 .IR win ,
78 as if by calling \fB\%waddch\fP(3NCURSES) for each
79 .I char
80 in
81 .IR str .
82 .B \%waddnstr
83 is similar,
84 but writes at most
85 .I n
86 characters.
87 If
88 .I n
89 is \-1,
90 .B \%waddnstr
91 writes the entire string.
92 \fB\%ncurses\fP(3NCURSES) describes the variants of these functions.
93 .SH RETURN VALUE
94 These functions return
95 .B OK
96 on success and
97 .B ERR
98 on failure.
99 .PP
100 In
101 .IR \%ncurses ","
102 they return
103 .B ERR
104 if
105 .bP
106 .I win
107 is
108 .IR NULL ","
109 .bP
110 .I str
111 is
112 .IR NULL ","
113 or
114 .bP
115 an internal \fB\%waddch\fP(3NCURSES) call returns
116 .BR ERR "."
117 .PP
118 Functions prefixed with \*(``mv\*('' first perform cursor movement and
119 fail if the position
120 .RI ( y ,
121 .IR x )
122 is outside the window boundaries.
123 .SH NOTES
124 All of these functions except
125 .B \%waddnstr
126 may be implemented as macros.
127 .SH PORTABILITY
128 X/Open Curses Issue\ 4 describes these functions.
129 It specifies no error conditions for them.
130 .PP
131 SVr4 describes a successful return value only as
132 \*(``an integer value other than
133 .IR ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 474
134 .SH HISTORY
135 4BSD (1980)
136 introduced
137 .I \%waddstr
138 along with its variants,
139 the latter defined as macros.
140 .PP
141 SVr3.1 (1987)
142 added
143 .I \%waddnstr
144 (and its variants)
145 redefining
146 .I \%waddstr
147 as a macro wrapping it.
148 .SH SEE ALSO
149 \fB\%addwstr\fP(3NCURSES) describes comparable functions of the
150 .I \%ncurses
151 library in its wide-character configuration
152 .RI \%( ncursesw ).
153 .PP
154 \fB\%ncurses\fP(3NCURSES),
155 \fB\%addch\fP(3NCURSES),
156 \fB\%addchstr\fP(3NCURSES)