1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
'\" te
.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH addch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
addch, mvaddch, mvwaddch, waddch \- add a character (with rendition) to a
window
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ]
#include <curses.h>
\fBint\fR \fBaddch\fR(\fBconst chtype\fR \fIch\fR);
.fi
.LP
.nf
\fBint\fR \fBmvaddch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype\fR \fIch\fR);
.fi
.LP
.nf
\fBint\fR \fBmvwaddch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype\fR \fIch\fR);
.fi
.LP
.nf
\fBint\fR \fBwaddch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype\fR \fIch\fR);
.fi
.SH DESCRIPTION
.sp
.LP
The \fBaddch()\fR function writes a character to the \fBstdscr\fR window at
the current cursor position. The \fBmvaddch()\fR and \fBmvwaddch()\fR
functions write the character to the position indicated by the \fIx\fR
(column) and \fIy\fR (row) parameters. The \fBmvaddch()\fR function writes the
character to the \fBstdscr\fR window, while \fBmvwaddch()\fR writes the
character to the window specified by \fIwin\fR. The \fBwaddch()\fR function is
identical to \fBaddch()\fR, but writes the character to the window specified
by \fIwin\fR.
.sp
.LP
These functions advance the cursor after writing the character. Characters that
do not fit on the end of the current line are wrapped to the beginning of the
next line unless the current line is the last line of the window and scrolling
is disabled. In that situation, characters which extend beyond the end of the
line are discarded.
.sp
.LP
When \fIch\fR is a backspace, carriage return, newline, or tab, X/Open Curses
moves the cursor appropriately. Each tab character moves the cursor to the next
tab stop. By default, tab stops occur every eight columns. When \fIch\fR is a
control character other than backspace, carriage return, newline, or tab, it
is written using \fB^\fR\fIx\fR notation, where \fIx\fR is a printable
character. When X/Open Curses writes \fIch\fR to the last character position
on a line, it automatically generates a newline. When \fIch\fR is written to
the last character position of a scrolling region and \fBscrollok()\fR is
enabled, X/Open Curses scrolls the scrolling region up one line (see
\fBclearok\fR(3XCURSES)).
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwchstr\fR\fR
.ad
.RS 10n
.rt
Is a pointer to the \fBcchar_t\fR string to be copied to the window.
.RE
.sp
.ne 2
.mk
.na
\fB\fIn\fR\fR
.ad
.RS 10n
.rt
Is the maximum number of characters to be copied from \fIwchstr\fR. If
\fIn\fR is less than 0, the entire string is written or as much of it as fits
on the line.
.RE
.sp
.ne 2
.mk
.na
\fB\fIy\fR\fR
.ad
.RS 10n
.rt
Is the y (row) coordinate of the starting position of \fIwchstr\fR in the
window.
.RE
.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 10n
.rt
Is the x (column) coordinate of the starting position of \fIwchstr\fR in the
window.
.RE
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 10n
.rt
Is a pointer to the window to which the string is to be copied.
.RE
.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityStandard
_
MT-LevelUnsafe
.TE
.SH SEE ALSO
.sp
.LP
\fBattroff\fR(3XCURSES), \fBbkgdset\fR(3XCURSES), \fBdoupdate\fR(3XCURSES),
\fBinch\fR(3XCURSES), \fBinsch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
\fBnl\fR(3XCURSES), \fBprintw\fR(3XCURSES), \fBscrollok\fR(3XCURSES),
\fBscrl\fR(3XCURSES), \fBterminfo\fR(4), \fBattributes\fR(5),
\fBstandards\fR(5)
|
