ncurses 6.0 - patch 20171118
[ncurses.git] / man / curs_instr.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_instr.3x,v 1.18 2017/11/18 23:47:37 tom Exp $
30 .TH curs_instr 3X ""
31 .ie \n(.g .ds `` \(lq
32 .el       .ds `` ``
33 .ie \n(.g .ds '' \(rq
34 .el       .ds '' ''
35 .de bP
36 .ie n  .IP \(bu 4
37 .el    .IP \(bu 2
38 ..
39 .SH NAME
40 \fBinstr\fR,
41 \fBinnstr\fR,
42 \fBwinstr\fR,
43 \fBwinnstr\fR,
44 \fBmvinstr\fR,
45 \fBmvinnstr\fR,
46 \fBmvwinstr\fR,
47 \fBmvwinnstr\fR \- get a string of characters from a \fBcurses\fR window
48 .SH SYNOPSIS
49 \fB#include <curses.h>\fR
50 .sp
51 \fBint instr(char *str);\fR
52 .br
53 \fBint innstr(char *str, int n);\fR
54 .br
55 \fBint winstr(WINDOW *win, char *str);\fR
56 .br
57 \fBint winnstr(WINDOW *win, char *str, int n);\fR
58 .br
59 \fBint mvinstr(int y, int x, char *str);\fR
60 .br
61 \fBint mvinnstr(int y, int x, char *str, int n);\fR
62 .br
63 \fBint mvwinstr(WINDOW *win, int y, int x, char *str);\fR
64 .br
65 \fBint mvwinnstr(WINDOW *win, int y, int x, char *str, int n);\fR
66 .br
67 .SH DESCRIPTION
68 These routines return a string of characters in \fIstr\fR, extracted starting
69 at the current cursor position in the named window.
70 Attributes are stripped from the characters.  The four
71 functions with \fIn\fR as the last argument return a leading substring at most
72 \fIn\fR characters long (exclusive of the trailing NUL).
73 .SH RETURN VALUE
74 All of the functions return \fBERR\fR upon failure,
75 or the number of characters actually read into the string.
76 .PP
77 X/Open Curses defines no error conditions.
78 In this implementation:
79 .bP
80 If the \fIwin\fP parameter is null, an error is returned,
81 .bP
82 If the \fIchstr\fP parameter is null, an error is returned,
83 .PP
84 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
85 \fBwmove\fP, and return an error if the position is outside the window,
86 or if the window pointer is null.
87 .SH NOTES
88 Note that all routines except \fBwinnstr\fR may be macros.
89 .SH PORTABILITY
90 SVr4 does not
91 document whether a length limit includes or excludes the trailing NUL.
92 .PP
93 The ncurses library extends the XSI description by allowing a negative
94 value for \fIn\fR.
95 In this case, the functions return the string ending at the right margin.
96 .SH SEE ALSO
97 \fBcurses\fR(3X).