freebsd-nq/lib/libncurses/curs_addstr.3
Mike Pritchard 3e6427f35f Correct man page section number references (e.g. don't use the
old 1M, 3X and 3S section numbers) and make some minor formatting
changes to silence manck.
1996-02-11 23:29:40 +00:00

45 lines
1.4 KiB
Groff

.TH curs_addstr 3 ""
.SH NAME
\fBaddstr\fR, \fBaddnstr\fR, \fBwaddstr\fR, \fBwaddnstr\fR,
\fBmvaddstr\fR, \fBmvaddnstr\fR, \fBmvwaddstr\fR,
\fBmvwaddnstr\fR - add a string of characters to a \fBncurses\fR window and advance cursor
.SH SYNOPSIS
\fB#include <ncurses.h>\fR
\fBint addstr(char *str);\fR
.br
\fBint addnstr(char *str, int n);\fR
.br
\fBint waddstr(WINDOW *win, char *str);\fR
.br
\fBint waddnstr(WINDOW *win, char *str, int n);\fR
.br
\fBint mvaddstr(y, int x, char *str);\fR
.br
\fBint mvaddnstr(y, int x, char *str, int n);\fR
.br
\fBint mvwaddstr(WINDOW *win, int y, int x, char *str);\fR
.br
\fBint mvwaddnstr(WINDOW *win, int y, int x, char *str,
int n);\fR
.SH DESCRIPTION
These routines write the characters of the null terminated character string
\fIstr\fR on the given window. It is similar to calling \fBwaddch\fR once for
each character in the string. The four routines with \fIn\fR as the last
argument write at most \fIn\fR characters. If \fIn\fR is negative, then the
entire string will be added.
.SH RETURN VALUE
All routines return the integer \fBERR\fR upon failure and an integer value
other than \fBERR\fR upon successful completion.
.SH NOTES
Note that all of these routines except \fBwaddstr\fR and \fBwaddnstr\fR may be
macros.
.SH SEE ALSO
\fBncurses\fR(3), \fBcurs_addch\fR(3).
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End: