8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3xcurses / mvprintw.3xcurses
blob60658c079cc47cda6203a30e41ec268f2cfd4534
1 '\" te
2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH MVPRINTW 3XCURSES "Jun 5, 2002"
7 .SH NAME
8 mvprintw, mvwprintw, printw, wprintw \- print formatted output window
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
17 #include <curses.h>
19 \fBint\fR \fBmvprintw\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
20 .fi
22 .LP
23 .nf
24 \fBint\fR \fBmvwprintw\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
25 .fi
27 .LP
28 .nf
29 \fBint\fR \fBprintw\fR(\fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
30 .fi
32 .LP
33 .nf
34 \fBint\fR \fBwprintw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
35 .fi
37 .SH PARAMETERS
38 .sp
39 .ne 2
40 .na
41 \fB\fIy\fR\fR
42 .ad
43 .RS 7n
44 Is the y (row) coordinate position of the string's placement in the window.
45 .RE
47 .sp
48 .ne 2
49 .na
50 \fB\fIx\fR\fR
51 .ad
52 .RS 7n
53 Is the x (column) coordinate position of the string's placement in the window.
54 .RE
56 .sp
57 .ne 2
58 .na
59 \fB\fIfmt\fR\fR
60 .ad
61 .RS 7n
62 Is a \fBprintf()\fR format string.
63 .RE
65 .sp
66 .ne 2
67 .na
68 \fB\fIwin\fR\fR
69 .ad
70 .RS 7n
71 Is a pointer to the window in which the string is to be written.
72 .RE
74 .SH DESCRIPTION
75 .sp
76 .LP
77 The \fBmvprintw()\fR, \fBmvwprintw()\fR, \fBprintw()\fR, and \fBwprintw()\fR
78 functions are analogous to \fBprintf\fR(3C). The effect of these functions is
79 as though \fBsprintf()\fR were used to format the string, and then
80 \fBwaddstr\fR(3XCURSES) were used to add that multi-byte string to the current
81 or specified window at the current or specified cursor position.
82 .SH RETURN VALUES
83 .sp
84 .LP
85 Upon successful completion, these functions return \fBOK\fR. Otherwise, they
86 return \fBERR\fR.
87 .SH ERRORS
88 .sp
89 .LP
90  No errors are defined.
91 .SH ATTRIBUTES
92 .sp
93 .LP
94 See \fBattributes\fR(5) for descriptions of the following attributes:
95 .sp
97 .sp
98 .TS
99 box;
100 c | c
101 l | l .
102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
104 Interface Stability     Standard
106 MT-Level        Unsafe
109 .SH SEE ALSO
112 \fBaddnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBprintf\fR(3C),
113 \fBattributes\fR(5), \fBstandards\fR(5)