| .\"*************************************************************************** |
| .\" Copyright 2018,2020 Thomas E. Dickey * |
| .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * |
| .\" * |
| .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| .\" copy of this software and associated documentation files (the * |
| .\" "Software"), to deal in the Software without restriction, including * |
| .\" without limitation the rights to use, copy, modify, merge, publish, * |
| .\" distribute, distribute with modifications, sublicense, and/or sell * |
| .\" copies of the Software, and to permit persons to whom the Software is * |
| .\" furnished to do so, subject to the following conditions: * |
| .\" * |
| .\" The above copyright notice and this permission notice shall be included * |
| .\" in all copies or substantial portions of the Software. * |
| .\" * |
| .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| .\" * |
| .\" Except as contained in this notice, the name(s) of the above copyright * |
| .\" holders shall not be used in advertising or otherwise to promote the * |
| .\" sale, use or other dealings in this Software without prior written * |
| .\" authorization. * |
| .\"*************************************************************************** |
| .\" |
| .\" $Id: curs_instr.3x,v 1.22 2020/10/18 00:18:27 tom Exp $ |
| .TH curs_instr 3X "" |
| .ie \n(.g .ds `` \(lq |
| .el .ds `` `` |
| .ie \n(.g .ds '' \(rq |
| .el .ds '' '' |
| .de bP |
| .ie n .IP \(bu 4 |
| .el .IP \(bu 2 |
| .. |
| .SH NAME |
| \fBinstr\fR, |
| \fBinnstr\fR, |
| \fBwinstr\fR, |
| \fBwinnstr\fR, |
| \fBmvinstr\fR, |
| \fBmvinnstr\fR, |
| \fBmvwinstr\fR, |
| \fBmvwinnstr\fR \- get a string of characters from a \fBcurses\fR window |
| .SH SYNOPSIS |
| \fB#include <curses.h>\fR |
| .sp |
| \fBint instr(char *\fP\fIstr\fP\fB);\fR |
| .br |
| \fBint innstr(char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR |
| .br |
| \fBint winstr(WINDOW *\fP\fIwin\fP\fB, char *\fP\fIstr\fP\fB);\fR |
| .br |
| \fBint winnstr(WINDOW *\fP\fIwin\fP\fB, char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR |
| .sp |
| \fBint mvinstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, char *\fP\fIstr\fP\fB);\fR |
| .br |
| \fBint mvinnstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR |
| .br |
| \fBint mvwinstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, char *\fP\fIstr\fP\fB);\fR |
| .br |
| \fBint mvwinnstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR |
| .br |
| .SH DESCRIPTION |
| These routines return a string of characters in \fIstr\fR, extracted starting |
| at the current cursor position in the named window. |
| Attributes are stripped from the characters. |
| The four |
| functions with \fIn\fR as the last argument return a leading substring at most |
| \fIn\fR characters long (exclusive of the trailing NUL). |
| .SH RETURN VALUE |
| All of the functions return \fBERR\fR upon failure, |
| or the number of characters actually read into the string. |
| .PP |
| X/Open Curses defines no error conditions. |
| In this implementation: |
| .bP |
| If the \fIwin\fP parameter is null, an error is returned, |
| .bP |
| If the \fIchstr\fP parameter is null, an error is returned, |
| .PP |
| Functions with a \*(``mv\*('' prefix first perform a cursor movement using |
| \fBwmove\fP, and return an error if the position is outside the window, |
| or if the window pointer is null. |
| .SH NOTES |
| Note that all routines except \fBwinnstr\fR may be macros. |
| .SH PORTABILITY |
| SVr4 does not |
| document whether a length limit includes or excludes the trailing NUL. |
| .PP |
| The ncurses library extends the XSI description by allowing a negative |
| value for \fIn\fR. |
| In this case, the functions return the string ending at the right margin. |
| .SH SEE ALSO |
| \fBcurses\fR(3X). |