X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inchstr.3x;h=0f2a91343734fdf2a58945a460c6522265611608;hp=daeafe25956fd96b1f8070742102e22d6356d5a0;hb=5c2245b6fc619f8d96ce940281dfbf13b5b8900b;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x index daeafe25..0f2a9134 100644 --- a/man/curs_inchstr.3x +++ b/man/curs_inchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 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_inchstr.3x,v 1.13 2010/07/31 16:08:48 tom Exp $ +.\" $Id: curs_inchstr.3x,v 1.16 2017/04/29 21:31:17 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 +.. .na .hy 0 .SH NAME @@ -74,10 +81,16 @@ All routines return the integer \fBERR\fR upon failure and an integer value other than \fBERR\fR upon successful completion (the number of characters retrieved, exclusive of the trailing 0). .PP -No error conditions are defined. -If the \fIchstr\fP parameter is null, -no data is returned, -and the return value is zero. +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 \fBwinchnstr\fR may be macros. SVr4 does not document whether the result string is zero-terminated; it does not document @@ -93,9 +106,3 @@ that the successful return of the functions is \fBOK\fR. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_in_wchstr\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: