X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_instr.3x;h=ff7d7f08e9c6103fdb039f43d4924c7728d7e848;hp=9a09ab278c477f814ff0b9d780c282474594e963;hb=cef50b3afcd58166f3541b701c97bce538844c76;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_instr.3x b/man/curs_instr.3x index 9a09ab27..ff7d7f08 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2000,2001 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.10 2001/11/03 19:58:56 tom Exp $ +.\" $Id: curs_instr.3x,v 1.15 2010/08/14 23:29:16 tom Exp $ .TH curs_instr 3X "" .SH NAME \fBinstr\fR, @@ -36,10 +36,10 @@ \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 \fBint instr(char *str);\fR .br \fBint innstr(char *str, int n);\fR @@ -65,13 +65,18 @@ functions with \fIn\fR as the last argument return a leading substring at most .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. +.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 -The XSI Curses -error conditions \fBEILSEQ\fR and \fBEILOVERFLOW\fR associated with -extended-level conformance are not yet detected (this implementation does not -yet support XPG4 multibyte characters). SVr4 does not document whether a length limit includes or excludes the trailing NUL. .PP @@ -86,4 +91,3 @@ In this case, the functions return the string ending at the right margin. .\"# mode:nroff .\"# fill-column:79 .\"# End: -