X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_instr.3x;h=a93de2728322d000f08879117cde4ded70f9a92d;hp=283ae19a1c4c6aca5f07bcc7007215b9f49516c5;hb=9fab8ab6b69130169a6880e63585d83efb1c1722;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/man/curs_instr.3x b/man/curs_instr.3x index 283ae19a..a93de272 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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.9 2000/07/01 20:05:03 tom Exp $ +.\" $Id: curs_instr.3x,v 1.13 2006/02/25 21:49:19 tom Exp $ .TH curs_instr 3X "" .SH NAME \fBinstr\fR, @@ -39,7 +39,7 @@ \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,14 @@ 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. .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 multi-byte characters). SVr4 does not document whether a length limit includes or excludes the trailing NUL. .PP @@ -86,4 +87,3 @@ In this case, the functions return the string ending at the right margin. .\"# mode:nroff .\"# fill-column:79 .\"# End: -