X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_instr.3x;h=4ab3e540a40172b26777f5e9869b54340928f841;hb=3183ac61c6bf0a75ee65dc8cbebf54f7c143df46;hp=dcc5f023085bf3281bb3dc1d9cd35f205c6f7049;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c;p=ncurses.git diff --git a/man/curs_instr.3x b/man/curs_instr.3x index dcc5f023..4ab3e540 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,56 +1,99 @@ -.\" $Id: curs_instr.3x,v 1.7 1997/03/15 23:25:24 tom Exp $ +.\"*************************************************************************** +.\" Copyright 2018-2021,2022 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.25 2022/02/12 20:05:11 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 +\fBinstr\fP, +\fBinnstr\fP, +\fBwinstr\fP, +\fBwinnstr\fP, +\fBmvinstr\fP, +\fBmvinnstr\fP, +\fBmvwinstr\fP, +\fBmvwinnstr\fP \- get a string of characters from a \fBcurses\fP window .SH SYNOPSIS -\fB#include \fR - -\fBint instr(char *str);\fR +\fB#include \fP +.sp +\fBint instr(char *\fIstr\fB);\fR .br -\fBint innstr(char *str, int n);\fR +\fBint innstr(char *\fIstr\fB, int \fIn\fB);\fR .br -\fBint winstr(WINDOW *win, char *str);\fR +\fBint winstr(WINDOW *\fIwin\fB, char *\fIstr\fB);\fR .br -\fBint winnstr(WINDOW *win, char *str, int n);\fR +\fBint winnstr(WINDOW *\fIwin\fB, char *\fIstr\fB, int \fIn\fB);\fR +.sp +\fBint mvinstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB);\fR .br -\fBint mvinstr(int y, int x, char *str);\fR +\fBint mvinnstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\fB);\fR .br -\fBint mvinnstr(int y, int x, char *str, int n);\fR +\fBint mvwinstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\fB);\fR .br -\fBint mvwinstr(WINDOW *win, int y, int x, char *str);\fR -.br -\fBint mvwinnstr(WINDOW *win, int y, int x, char *str, int n);\fR +\fBint mvwinnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\fB);\fR .br .SH DESCRIPTION -These routines return a string of characters in \fIstr\fR, extracted starting +These routines return a string of characters in \fIstr\fP, 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). +Attributes are stripped from the characters. +The four +functions with \fIn\fP as the last argument return a leading substring at most +\fIn\fP characters long (exclusive of the trailing NUL). .SH RETURN VALUE -All of the functions return \fBERR\fR upon failure, +All of the functions return \fBERR\fP 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. +Note that all routines except \fBwinnstr\fP may be macros. .SH PORTABILITY -The XSI Curses -error conditions \fBEILSEQ\fR and \fBEILOVERFLOW\fR associated with -extended-level conformance are not yet detected (this implementation does not -yet support XPG4 multi-byte characters). 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. +value for \fIn\fP. In this case, the functions return the string ending at the right margin. .SH SEE ALSO -\fBcurses\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: - +\fBcurses\fP(3X).