diff options
Diffstat (limited to 'man/curs_instr.3x')
| -rw-r--r-- | man/curs_instr.3x | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/man/curs_instr.3x b/man/curs_instr.3x index 1b17db952d11..2c148bc404dd 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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,8 +26,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.16 2010/12/04 18:38:55 tom Exp $ +.\" $Id: curs_instr.3x,v 1.19 2018/07/28 21:34:06 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, @@ -59,19 +67,22 @@ .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 +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 defines no error conditions. -In this implementation, -if the window parameter is null or the str parameter is null, -a zero is returned. +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 +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 |