X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getstr.3x;h=a5f186e8ccfa80673d1bbdb393a2a58bf03e3c18;hp=1a32a0be1aeb82fe36f4b8f6c07e5912f4bf7a32;hb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x index 1a32a0be..a5f186e8 100644 --- a/man/curs_getstr.3x +++ b/man/curs_getstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2000,2001 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2003,2005 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,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getstr.3x,v 1.11 2002/04/13 22:14:30 tom Exp $ +.\" $Id: curs_getstr.3x,v 1.14 2005/05/15 16:17:55 tom Exp $ .TH curs_getstr 3X "" +.na +.hy 0 .SH NAME \fBgetstr\fR, \fBgetnstr\fR, @@ -37,6 +39,8 @@ \fBmvgetnstr\fR, \fBmvwgetstr\fR, \fBmvwgetnstr\fR - accept character strings from \fBcurses\fR terminal keyboard +.ad +.hy .SH SYNOPSIS \fB#include \fR @@ -79,6 +83,13 @@ motion). All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4 specifies only "an integer value other than \fBERR\fR") upon successful completion. +.PP +X/Open defines no error conditions. +.PP +In this implementation, +these functions return an error +if the window pointer is null, or +if its timeout expires without having any data. .SH NOTES Note that \fBgetstr\fR, \fBmvgetstr\fR, and \fBmvwgetstr\fR may be macros. .SH PORTABILITY @@ -90,7 +101,7 @@ or if the lower-level \fBwgetch\fR call returns an ERR. SVr3 and early SVr4 curses implementations did not reject function keys; the SVr4.0 documentation claimed that "special keys" (such as function -keys, "home" key, "clear" key, \fIetc\fR.) are interpreted" without +keys, "home" key, "clear" key, \fIetc\fR.) are "interpreted", without giving details. It lied. In fact, the `character' value appended to the string by those implementations was predictable but not useful (being, in fact, the low-order eight bits of the key's KEY_ value).