X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inchstr.3x;h=d352c385c853704b308eb3b8166603e722c62c5f;hp=0f2a91343734fdf2a58945a460c6522265611608;hb=d6c65d287166c3105ece4a5e3f3ec7af5a5f26a3;hpb=8e397cccba0aad135cb9a8a353756f4273a7cdf6 diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x index 0f2a9134..d352c385 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,14 +27,15 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inchstr.3x,v 1.16 2017/04/29 21:31:17 tom Exp $ +.\" $Id: curs_inchstr.3x,v 1.19 2020/02/02 23:34:34 tom Exp $ .TH curs_inchstr 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` .ie \n(.g .ds '' \(rq .el .ds '' '' .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .na .hy 0 @@ -70,7 +72,8 @@ .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 @@ -92,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).