summaryrefslogtreecommitdiff
path: root/lib/libcurses/curs_instr.3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libcurses/curs_instr.3')
-rw-r--r--lib/libcurses/curs_instr.318
1 files changed, 9 insertions, 9 deletions
diff --git a/lib/libcurses/curs_instr.3 b/lib/libcurses/curs_instr.3
index dcf93b6e030..140ffcde798 100644
--- a/lib/libcurses/curs_instr.3
+++ b/lib/libcurses/curs_instr.3
@@ -1,7 +1,7 @@
-.\" $OpenBSD: curs_instr.3,v 1.7 2000/07/10 03:06:07 millert Exp $
+.\" $OpenBSD: curs_instr.3,v 1.8 2010/01/12 23:21:59 nicm Exp $
.\"
.\"***************************************************************************
-.\" 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 *
@@ -28,7 +28,7 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $From: curs_instr.3x,v 1.9 2000/07/01 20:05:03 tom Exp $
+.\" $Id: curs_instr.3,v 1.8 2010/01/12 23:21:59 nicm Exp $
.TH curs_instr 3 ""
.SH NAME
\fBinstr\fR,
@@ -41,7 +41,7 @@
\fBmvwinnstr\fR - get a string of characters from a \fBcurses\fR window
.SH SYNOPSIS
\fB#include <curses.h>\fR
-
+.sp
\fBint instr(char *str);\fR
.br
\fBint innstr(char *str, int n);\fR
@@ -67,13 +67,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
@@ -88,4 +89,3 @@ In this case, the functions return the string ending at the right margin.
.\"# mode:nroff
.\"# fill-column:79
.\"# End:
-