X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_instr.3x;h=4ab3e540a40172b26777f5e9869b54340928f841;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=7cc4b4bc1a1c0e24d87b9e8ac887d96ecd0117e5;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;p=ncurses.git diff --git a/man/curs_instr.3x b/man/curs_instr.3x index 7cc4b4bc..4ab3e540 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.22 2020/10/18 00:18:27 tom Exp $ +.\" $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 `` `` @@ -38,42 +38,42 @@ .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 +\fB#include \fP .sp -\fBint instr(char *\fP\fIstr\fP\fB);\fR +\fBint instr(char *\fIstr\fB);\fR .br -\fBint innstr(char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint innstr(char *\fIstr\fB, int \fIn\fB);\fR .br -\fBint winstr(WINDOW *\fP\fIwin\fP\fB, char *\fP\fIstr\fP\fB);\fR +\fBint winstr(WINDOW *\fIwin\fB, char *\fIstr\fB);\fR .br -\fBint winnstr(WINDOW *\fP\fIwin\fP\fB, char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint winnstr(WINDOW *\fIwin\fB, char *\fIstr\fB, int \fIn\fB);\fR .sp -\fBint mvinstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, char *\fP\fIstr\fP\fB);\fR +\fBint mvinstr(int \fIy\fB, int \fIx\fB, char *\fIstr\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 +\fBint mvinnstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\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 +\fBint mvwinstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\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 +\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). +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. @@ -87,13 +87,13 @@ 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 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). +\fBcurses\fP(3X).