man/curs_inchstr.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2010,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_inchstr.3x,v 1.47 2024/05/25 20:10:58 tom Exp $
  31 .TH curs_inchstr 3X 2024-05-25 "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\%inchstr\fP,
  49 \fB\%inchnstr\fP,
  50 \fB\%winchstr\fP,
  51 \fB\%winchnstr\fP,
  52 \fB\%mvinchstr\fP,
  53 \fB\%mvinchnstr\fP,
  54 \fB\%mvwinchstr\fP,
  55 \fB\%mvwinchnstr\fP \-
  56 get a \fIcurses\fR character string from a window
  57 .SH SYNOPSIS
  58 .nf
  59 \fB#include <curses.h>
  60 .PP
  61 \fBint inchstr(chtype *\fIchstr\fP);
  62 \fBint inchnstr(chtype *\fIchstr\fP, int \fIn\fP);
  63 \fBint winchstr(WINDOW *\fIwin\fP, chtype *\fIchstr\fP);
  64 \fBint winchnstr(WINDOW *\fIwin\fP, chtype *\fIchstr\fP, int \fIn\fP);
  65 .PP
  66 \fBint mvinchstr(int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP);
  67 \fBint mvinchnstr(int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP, int \fIn\fP);
  68 \fBint mvwinchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP);
  69 \fBint mvwinchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP, int \fIn\fP);
  70 .fi
  71 .SH DESCRIPTION
  72 These routines return a NULL-terminated array of \fBchtype\fP quantities,
  73 starting at the current cursor position in the named window and ending at the
  74 right margin of the window.
  75 .PP
  76 The four functions with \fIn\fP as the last argument, return
  77 a leading substring at most \fIn\fP characters long
  78 (exclusive of the trailing (chtype)0).
  79 Transfer stops at the end of the current line, or when \fIn\fP characters have
  80 been stored at the location referenced by \fIchstr\fP.
  81 .PP
  82 Constants defined in \fB<curses.h>\fP can be used with the \fB&\fP (logical
  83 AND) operator to extract the character or the attribute alone from any position
  84 in the \fIchstr\fP [see \fBcurs_inch\fP(3X)].
  85 .SH RETURN VALUE
  86 All routines return the integer \fBERR\fP upon failure and an integer value
  87 other than \fBERR\fP upon successful completion (the number of characters
  88 retrieved, exclusive of the trailing 0).
  89 .PP
  90 X/Open Curses defines no error conditions.
  91 This implementation returns
  92 .B ERR
  93 .bP
  94 if the \fIwin\fP parameter is null or
  95 .bP
  96 if the \fIchstr\fP parameter is null.
  97 .PP
  98 Functions prefixed with \*(``mv\*('' first perform cursor movement and
  99 fail if the position
 100 .RI ( y ,
 101 .IR x )
 102 is outside the window boundaries.
 103 .SH NOTES
 104 All routines except \fBwinchnstr\fP may be macros.
 105 .PP
 106 SVr4 does not
 107 document whether the result string is zero-terminated; it does not document
 108 whether a length limit argument includes any trailing 0; and it does not
 109 document the meaning of the return value.
 110 .PP
 111 Reading a line that overflows the array pointed to by
 112 \fIchstr\fP
 113 with
 114 \fBinchstr\fP,
 115 \fBmvinchstr\fP,
 116 \fBmvwinchstr\fP
 117 or
 118 \fBwinchstr\fP
 119 causes undefined results.
 120 Therefore, the use of
 121 \fBinchnstr\fP,
 122 \fBmvinchnstr\fP,
 123 \fBmvwinchnstr\fP, or
 124 \fBwinchnstr\fP
 125 is recommended.
 126 .SH PORTABILITY
 127 These functions are described in X/Open Curses, Issue 4.
 128 It is no
 129 more specific than the SVr4 documentation on the trailing 0.
 130 It does specify
 131 that the successful return of the functions is \fBOK\fP.
 132 .SH SEE ALSO
 133 \fB\%curses\fP(3X),
 134 \fB\%curs_inch\fP(3X),
 135 \fB\%curs_inwstr\fP(3X),
 136 \fB\%curs_in_wchstr\fP(3X)