man/curs_instr.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2022,2023 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_instr.3x,v 1.44 2023/12/16 20:32:22 tom Exp $
  31 .TH curs_instr 3X 2023-12-16 "ncurses 6.4" "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\%instr\fP,
  49 \fB\%innstr\fP,
  50 \fB\%winstr\fP,
  51 \fB\%winnstr\fP,
  52 \fB\%mvinstr\fP,
  53 \fB\%mvinnstr\fP,
  54 \fB\%mvwinstr\fP,
  55 \fB\%mvwinnstr\fP \-
  56 get a string from a \fIcurses\fR window
  57 .SH SYNOPSIS
  58 .nf
  59 \fB#include <curses.h>
  60 .PP
  61 \fBint instr(char *\fIstr\fP);
  62 \fBint innstr(char *\fIstr\fP, int \fIn\fP);
  63 \fBint winstr(WINDOW *\fIwin\fP, char *\fIstr\fP);
  64 \fBint winnstr(WINDOW *\fIwin\fP, char *\fIstr\fP, int \fIn\fP);
  65 .PP
  66 \fBint mvinstr(int \fIy\fP, int \fIx\fP, char *\fIstr\fP);
  67 \fBint mvinnstr(int \fIy\fP, int \fIx\fP, char *\fIstr\fP, int \fIn\fP);
  68 \fBint mvwinstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, char *\fIstr\fP);
  69 \fBint mvwinnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, char *\fIstr\fP, int \fIn\fP);
  70 .fi
  71 .SH DESCRIPTION
  72 These routines return a string of characters in \fIstr\fP,
  73 starting at the current cursor position in the named window.
  74 Attributes are stripped from the characters.
  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 NUL).
  79 Transfer stops at the end of the current line, or when \fIn\fP characters have
  80 been stored at the location referenced by \fIstr\fP.
  81 .SH RETURN VALUE
  82 All of the functions return \fBERR\fP upon failure,
  83 or the number of characters actually read into the string.
  84 .PP
  85 X/Open Curses defines no error conditions.
  86 This implementation returns an error
  87 .bP
  88 if the \fIwin\fP parameter is null or
  89 .bP
  90 if the \fIchstr\fP parameter is null.
  91 .PP
  92 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
  93 \fBwmove\fP, and return an error if the position is outside the window,
  94 or if the window pointer is null.
  95 .SH NOTES
  96 All routines except \fBwinnstr\fP may be macros.
  97 .PP
  98 Reading a line that overflows the array pointed to by
  99 \fIstr\fP
 100 with
 101 \fBinstr\fP,
 102 \fBmvinstr\fP,
 103 \fBmvwinstr\fP
 104 or
 105 \fBwinstr\fP
 106 causes undefined results.
 107 Therefore, the use of
 108 \fBinnstr\fP,
 109 \fBmvinnstr\fP,
 110 \fBmvwinnstr\fP, or
 111 \fBwinnstr\fP
 112 is recommended.
 113 .SH PORTABILITY
 114 SVr4 does not
 115 document whether a length limit includes or excludes the trailing NUL.
 116 .PP
 117 The \fI\%ncurses\fP library extends the XSI description by allowing a
 118 negative value for \fIn\fP.
 119 In this case, the functions return the string ending at the right margin.
 120 .SH SEE ALSO
 121 \fB\%curses\fP(3X),
 122 \fB\%curs_inch\fP(3X),
 123 \fB\%curs_inchstr\fP(3X),
 124 \fB\%curs_inwstr\fP(3X),
 125 \fB\%curs_in_wchstr\fP(3X)