man/curs_addchstr.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_addchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp $
  31 .TH curs_addchstr 3X 2024-04-20 "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\%addchstr\fP,
  49 \fB\%addchnstr\fP,
  50 \fB\%waddchstr\fP,
  51 \fB\%waddchnstr\fP,
  52 \fB\%mvaddchstr\fP,
  53 \fB\%mvaddchnstr\fP,
  54 \fB\%mvwaddchstr\fP,
  55 \fB\%mvwaddchnstr\fP \-
  56 add a \fIcurses\fR character string to a window
  57 .SH SYNOPSIS
  58 .nf
  59 \fB#include <curses.h>
  60 .PP
  61 \fBint addchstr(const chtype *\fIchstr\fP);
  62 \fBint waddchstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP);
  63 \fBint mvaddchstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP);
  64 \fBint mvwaddchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP);
  65 .PP
  66 \fBint addchnstr(const chtype *\fIchstr\fP, int \fIn\fP);
  67 \fBint waddchnstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP, int \fIn\fP);
  68 \fBint mvaddchnstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP);
  69 \fBint mvwaddchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP);
  70 .fi
  71 .SH DESCRIPTION
  72 These functions copy the (null-terminated)
  73 \fIchstr\fP array
  74 into the window image structure
  75 starting at the current cursor position.
  76 .PP
  77 The four functions with \fIn\fP as the last
  78 argument copy at most \fIn\fP elements,
  79 but no more than will fit on the line.
  80 If \fBn\fP=\fB\-1\fP then the whole array is copied,
  81 to the maximum number of characters that will fit on the line.
  82 .PP
  83 The window cursor is \fInot\fP advanced.
  84 These functions are faster than \fBwaddnstr\fP.
  85 On the other hand:
  86 .bP
  87 they do not perform checking
  88 (such as for the newline, backspace, or carriage return characters),
  89 .bP
  90 they do not advance the current cursor position,
  91 .bP
  92 they do not expand other control characters to ^-escapes, and
  93 .bP
  94 they truncate the string if it crosses the right margin,
  95 rather than wrapping it around to the new line.
  96 .SH RETURN VALUE
  97 All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
  98 .PP
  99 X/Open Curses does not specify any error conditions.
 100 This implementation returns an error
 101 .bP
 102 if the \fIwin\fP parameter is null or
 103 .bP
 104 if the \fIwchstr\fP parameter is null.
 105 .PP
 106 Functions prefixed with \*(``mv\*('' first perform cursor movement and
 107 fail if the position
 108 .RI ( y ,
 109 .IR x )
 110 is outside the window boundaries.
 111 .SH NOTES
 112 All functions except \fBwaddchnstr\fP may be macros.
 113 .SH PORTABILITY
 114 These functions are described in X/Open Curses, Issue 4.
 115 .SH SEE ALSO
 116 \fB\%curs_add_wchstr\fP(3X) describes comparable functions of the
 117 .I \%ncurses
 118 library in its wide-character configuration
 119 .RI ( \%ncursesw ).
 120 .PP
 121 \fB\%curses\fP(3X),
 122 \fB\%curs_addch\fP(3X),
 123 \fB\%curs_addstr\fP(3X)