X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_instr.3x;h=bb6435b197adf0370f2b050d5a6e3e85004f92fe;hp=a93de2728322d000f08879117cde4ded70f9a92d;hb=5c2245b6fc619f8d96ce940281dfbf13b5b8900b;hpb=027ae42953e3186daed8f3882da73de48291b606;ds=sidebyside diff --git a/man/curs_instr.3x b/man/curs_instr.3x index a93de272..bb6435b1 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 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,8 +26,15 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.13 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_instr.3x,v 1.17 2017/04/29 21:37:55 tom Exp $ .TH curs_instr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.de bP +.IP \(bu 4 +.. .SH NAME \fBinstr\fR, \fBinnstr\fR, @@ -36,7 +43,7 @@ \fBmvinstr\fR, \fBmvinnstr\fR, \fBmvwinstr\fR, -\fBmvwinnstr\fR - get a string of characters from a \fBcurses\fR window +\fBmvwinnstr\fR \- get a string of characters from a \fBcurses\fR window .SH SYNOPSIS \fB#include \fR .sp @@ -66,10 +73,16 @@ functions with \fIn\fR as the last argument return a leading substring at most 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 +\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. .SH PORTABILITY @@ -81,9 +94,3 @@ value for \fIn\fR. 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: