X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inchstr.3x;h=332604e789963892f213dbc8399c188663572512;hp=853c2421e24351554afeab31fce3c640a4c0cf32;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=06078d3fa68db669ed37178c01873546b4b28745 diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x index 853c2421..332604e7 100644 --- a/man/curs_inchstr.3x +++ b/man/curs_inchstr.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc. * +.\" 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 * @@ -26,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inchstr.3x,v 1.17 2017/11/18 23:47:37 tom Exp $ +.\" $Id: curs_inchstr.3x,v 1.21 2020/10/18 00:24:36 tom Exp $ .TH curs_inchstr 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -52,26 +53,27 @@ .SH SYNOPSIS \fB#include \fR .sp -\fBint inchstr(chtype *chstr);\fR +\fBint inchstr(chtype *\fP\fIchstr\fP\fB);\fR .br -\fBint inchnstr(chtype *chstr, int n);\fR +\fBint inchnstr(chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR .br -\fBint winchstr(WINDOW *win, chtype *chstr);\fR +\fBint winchstr(WINDOW *\fP\fIwin\fP\fB, chtype *\fP\fIchstr\fP\fB);\fR .br -\fBint winchnstr(WINDOW *win, chtype *chstr, int n);\fR -.br -\fBint mvinchstr(int y, int x, chtype *chstr);\fR +\fBint winchnstr(WINDOW *\fP\fIwin\fP\fB, chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR +.sp +\fBint mvinchstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype *\fP\fIchstr\fP\fB);\fR .br -\fBint mvinchnstr(int y, int x, chtype *chstr, int n);\fR +\fBint mvinchnstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR .br -\fBint mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);\fR +\fBint mvwinchstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype *\fP\fIchstr\fP\fB);\fR .br -\fBint mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);\fR +\fBint mvwinchnstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR .br .SH DESCRIPTION These routines return a NULL-terminated array of \fBchtype\fR quantities, starting at the current cursor position in the named window and ending at the -right margin of the window. The four functions with \fIn\fR as +right margin of the window. +The four functions with \fIn\fR as the last argument, return a leading substring at most \fIn\fR characters long (exclusive of the trailing (chtype)0). Constants defined in \fB\fR can be used with the \fB&\fR (logical @@ -93,13 +95,16 @@ 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 \fBwinchnstr\fR may be macros. SVr4 does not +Note that all routines except \fBwinchnstr\fR may be macros. +SVr4 does not document whether the result string is zero-terminated; it does not document whether a length limit argument includes any trailing 0; and it does not document the meaning of the return value. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. It is no -more specific than the SVr4 documentation on the trailing 0. It does specify +These functions are described in the XSI Curses standard, Issue 4. +It is no +more specific than the SVr4 documentation on the trailing 0. +It does specify that the successful return of the functions is \fBOK\fR. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inch\fR(3X).