ncurses 6.2 - patch 20200212
[ncurses.git] / man / curs_inchstr.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 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.19 2020/02/02 23:34:34 tom Exp $
31 .TH curs_inchstr 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .de bP
37 .ie n  .IP \(bu 4
38 .el    .IP \(bu 2
39 ..
40 .na
41 .hy 0
42 .SH NAME
43 \fBinchstr\fR,
44 \fBinchnstr\fR,
45 \fBwinchstr\fR,
46 \fBwinchnstr\fR,
47 \fBmvinchstr\fR,
48 \fBmvinchnstr\fR,
49 \fBmvwinchstr\fR,
50 \fBmvwinchnstr\fR \- get a string of characters (and attributes) from a \fBcurses\fR window
51 .ad
52 .hy
53 .SH SYNOPSIS
54 \fB#include <curses.h>\fR
55 .sp
56 \fBint inchstr(chtype *chstr);\fR
57 .br
58 \fBint inchnstr(chtype *chstr, int n);\fR
59 .br
60 \fBint winchstr(WINDOW *win, chtype *chstr);\fR
61 .br
62 \fBint winchnstr(WINDOW *win, chtype *chstr, int n);\fR
63 .br
64 \fBint mvinchstr(int y, int x, chtype *chstr);\fR
65 .br
66 \fBint mvinchnstr(int y, int x, chtype *chstr, int n);\fR
67 .br
68 \fBint mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);\fR
69 .br
70 \fBint mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);\fR
71 .br
72 .SH DESCRIPTION
73 These routines return a NULL-terminated array of \fBchtype\fR quantities,
74 starting at the current cursor position in the named window and ending at the
75 right margin of the window.
76 The four functions with \fIn\fR as
77 the last argument, return a leading substring at most \fIn\fR characters long
78 (exclusive of the trailing (chtype)0).
79 Constants defined in \fB<curses.h>\fR can be used with the \fB&\fR (logical
80 AND) operator to extract the character or the attribute alone from any position
81 in the \fIchstr\fR [see \fBcurs_inch\fR(3X)].
82 .SH RETURN VALUE
83 All routines return the integer \fBERR\fR upon failure and an integer value
84 other than \fBERR\fR upon successful completion (the number of characters
85 retrieved, exclusive of the trailing 0).
86 .PP
87 X/Open Curses defines no error conditions.
88 In this implementation:
89 .bP
90 If the \fIwin\fP parameter is null, an error is returned,
91 .bP
92 If the \fIchstr\fP parameter is null, an error is returned,
93 .PP
94 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
95 \fBwmove\fP, and return an error if the position is outside the window,
96 or if the window pointer is null.
97 .SH NOTES
98 Note that all routines except \fBwinchnstr\fR may be macros.
99 SVr4 does not
100 document whether the result string is zero-terminated; it does not document
101 whether a length limit argument includes any trailing 0; and it does not
102 document the meaning of the return value.
103 .SH PORTABILITY
104 These functions are described in the XSI Curses standard, Issue 4.
105 It is no
106 more specific than the SVr4 documentation on the trailing 0.
107 It does specify
108 that the successful return of the functions is \fBOK\fR.
109 .SH SEE ALSO
110 \fBcurses\fR(3X), \fBcurs_inch\fR(3X).
111 .PP
112 Comparable functions in the wide-character (ncursesw) library are
113 described in
114 \fBcurs_in_wchstr\fR(3X).