lib/libncurses/curs_addstr.3

   1 .\" $FreeBSD$
   2 .\"
   3 .TH curs_addstr 3 ""
   4 .SH NAME
   5 \fBaddstr\fR, \fBaddnstr\fR, \fBwaddstr\fR, \fBwaddnstr\fR,
   6 \fBmvaddstr\fR, \fBmvaddnstr\fR, \fBmvwaddstr\fR,
   7 \fBmvwaddnstr\fR - add a string of characters to a \fBncurses\fR window and advance cursor
   8 .SH SYNOPSIS
   9 \fB#include <ncurses.h>\fR
  10
  11 \fBint addstr(char *str);\fR
  12 .br
  13 \fBint addnstr(char *str, int n);\fR
  14 .br
  15 \fBint waddstr(WINDOW *win, char *str);\fR
  16 .br
  17 \fBint waddnstr(WINDOW *win, char *str, int n);\fR
  18 .br
  19 \fBint mvaddstr(int y, int x, char *str);\fR
  20 .br
  21 \fBint mvaddnstr(int y, int x, char *str, int n);\fR
  22 .br
  23 \fBint mvwaddstr(WINDOW *win, int y, int x, char *str);\fR
  24 .br
  25 \fBint mvwaddnstr(WINDOW *win, int y, int x, char *str,
  26       int n);\fR
  27 .SH DESCRIPTION
  28 These routines write the characters of the null terminated character string
  29 \fIstr\fR on the given window.  It is similar to calling \fBwaddch\fR once for
  30 each character in the string.  The four routines with \fIn\fR as the last
  31 argument write at most \fIn\fR characters.  If \fIn\fR is negative, then the
  32 entire string will be added.
  33 .SH RETURN VALUE
  34 All routines return the integer \fBERR\fR upon failure and an integer value
  35 other than \fBERR\fR upon successful completion.
  36 .SH NOTES
  37 Note that all of these routines except \fBwaddstr\fR and \fBwaddnstr\fR may be
  38 macros.
  39 .SH SEE ALSO
  40 \fBncurses\fR(3), \fBcurs_addch\fR(3).
  41 .\"#
  42 .\"# The following sets edit modes for GNU EMACS
  43 .\"# Local Variables:
  44 .\"# mode:nroff
  45 .\"# fill-column:79
  46 .\"# End: