man/curs_addstr.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2019-2023,2024 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.51 2024/06/22 21:26:53 tom Exp $
  31 .TH curs_addstr 3X 2024-06-22 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "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\%addnstr\fP,
  50 \fB\%waddstr\fP,
  51 \fB\%waddnstr\fP,
  52 \fB\%mvaddstr\fP,
  53 \fB\%mvaddnstr\fP,
  54 \fB\%mvwaddstr\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 mvaddstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP);
  63 \fBint mvwaddstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP);
  64 \fBint waddstr(WINDOW *\fIwin\fP, const char *\fIstr\fP);
  65 .PP
  66 \fBint addnstr(const char *\fIstr\fP, int \fIn\fP);
  67 \fBint mvaddnstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP);
  68 \fBint mvwaddnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP);
  69 \fBint waddnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP);
  70 .fi
  71 .SH DESCRIPTION
  72 .B waddstr
  73 writes the characters of the (null-terminated) string
  74 .I str
  75 to the window
  76 .IR win .
  77 Its process is similar to calling \fB\%waddch\fP(3X) for each
  78 .I char
  79 in
  80 .IR str .
  81 Control characters are processed as in \fB\%waddch\fP(3X).
  82 .PP
  83 .B waddnstr
  84 writes at most
  85 .I n
  86 characters,
  87 or until a terminating null character occurs in
  88 .IR str .
  89 If
  90 .I n
  91 is \-1,
  92 .B
  93 .B waddnstr
  94 writes the entire string.
  95 .PP
  96 \fB\%ncurses\fP(3X) describes the variants of these functions.
  97 .SH RETURN VALUE
  98 These functions return
  99 .B OK
 100 on success and
 101 .B ERR
 102 on failure.
 103 .PP
 104 In
 105 .IR \%ncurses ","
 106 they return
 107 .B ERR
 108 if
 109 .bP
 110 .I win
 111 is
 112 .BR NULL ","
 113 .bP
 114 .I str
 115 is
 116 .BR NULL ","
 117 or
 118 .bP
 119 an internal \fB\%waddch\fP(3X) call returns
 120 .BR ERR "."
 121 .PP
 122 Functions prefixed with \*(``mv\*('' first perform cursor movement and
 123 fail if the position
 124 .RI ( y ,
 125 .IR x )
 126 is outside the window boundaries.
 127 .SH NOTES
 128 All of these functions except \fBwaddnstr\fP may be macros.
 129 .SH PORTABILITY
 130 X/Open Curses,
 131 Issue 4 describes these functions.
 132 It specifies no error conditions for them.
 133 .SH HISTORY
 134 4BSD (1980)
 135 .I curses
 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\%curs_addwstr\fP(3X) describes comparable functions of the
 150 .I \%ncurses
 151 library in its wide-character configuration
 152 .RI \%( ncursesw ).
 153 .PP
 154 \fB\%curses\fP(3X),
 155 \fB\%curs_addch\fP(3X),
 156 \fB\%curs_addchstr\fP(3X)