diff options
Diffstat (limited to 'contrib/ncurses/man/curs_inchstr.3x')
| -rw-r--r-- | contrib/ncurses/man/curs_inchstr.3x | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/contrib/ncurses/man/curs_inchstr.3x b/contrib/ncurses/man/curs_inchstr.3x index 60f9d56..18c21dc 100644 --- a/contrib/ncurses/man/curs_inchstr.3x +++ b/contrib/ncurses/man/curs_inchstr.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,8 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inchstr.3x,v 1.8 2000/07/01 20:16:18 tom Exp $ +.\" $Id: curs_inchstr.3x,v 1.12 2006/12/02 17:00:58 tom Exp $ .TH curs_inchstr 3X "" +.na +.hy 0 .SH NAME \fBinchstr\fR, \fBinchnstr\fR, @@ -37,9 +39,11 @@ \fBmvinchnstr\fR, \fBmvwinchstr\fR, \fBmvwinchnstr\fR - get a string of characters (and attributes) from a \fBcurses\fR window +.ad +.hy .SH SYNOPSIS \fB#include <curses.h>\fR - +.sp \fBint inchstr(chtype *chstr);\fR .br \fBint inchnstr(chtype *chstr, int n);\fR @@ -69,6 +73,11 @@ in the \fIchstr\fR [see \fBcurs_inch\fR(3X)]. 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. .SH NOTES Note that all routines except \fBwinchnstr\fR may be macros. SVr4 does not document whether the result string is 0-terminated; it does not document @@ -80,6 +89,10 @@ more specific than the SVr4 documentation on the trailing 0. It does specify that the successful return of the functions is \fBOK\fR. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inch\fR(3X). +.PP +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: |
