X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_instr.3x;h=6d64353ae74e66360e4ac12ba106296b14ad5ff9;hb=5da4544722decdeb2bfd0c7c4581af0ea62148f9;hp=5e79f8139400ff9038b582b187cfa202edd33409;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e;p=ncurses.git diff --git a/man/curs_instr.3x b/man/curs_instr.3x index 5e79f813..6d64353a 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-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,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.14 2010/07/31 16:11:27 tom Exp $ +.\" $Id: curs_instr.3x,v 1.18 2017/11/18 23:47:37 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, @@ -66,10 +74,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 +95,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: