summaryrefslogtreecommitdiff
path: root/usr/src/man/man3curses/curs_inwchstr.3curses
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3curses/curs_inwchstr.3curses
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-joyent-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com Reviewed by: gwr@nexenta.com Reviewed by: trisk@opensolaris.org Approved by: gwr@nexenta.com --HG-- extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3curses/curs_inwchstr.3curses')
-rw-r--r--usr/src/man/man3curses/curs_inwchstr.3curses102
1 files changed, 102 insertions, 0 deletions
diff --git a/usr/src/man/man3curses/curs_inwchstr.3curses b/usr/src/man/man3curses/curs_inwchstr.3curses
new file mode 100644
index 0000000000..cadf790d10
--- /dev/null
+++ b/usr/src/man/man3curses/curs_inwchstr.3curses
@@ -0,0 +1,102 @@
+'\" te
+.\" Copyright 1989 AT&T
+.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
+.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
+.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
+.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
+.TH curs_inwchstr 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
+.SH NAME
+curs_inwchstr, inwchstr, inwchnstr, winwchstr, winwchnstr, mvinwchstr,
+mvinwchnstr, mvwinwchstr, mvwinwchnstr \- get a string of wchar_t characters
+(and attributes) from a curses window
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR .. ]
+#include <curses.h>
+
+\fBint\fR \fBinwchstr\fR(\fBchtype *\fR\fIwchstr\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBinwchnstr\fR(\fBchtype *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBwinwchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype *\fR\fIwchstr\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBwinwchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBmvinwchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIwchstr\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBmvinwchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBmvwinwchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIwchstr\fR);
+.fi
+
+.LP
+.nf
+\fBint\fR \fBmvwinwchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+These routines return a string of type \fBchtype\fR, holding \fBwchar_t\fR
+characters, starting at the current cursor position in the named window and
+ending at the right margin of the window. The four functions with \fIn\fR as
+the last argument, return the string at most \fIn\fR \fBwchar_t\fR characters
+long. Constants defined in \fB<curses.h>\fR can be used with the logical AND
+(\fB&\fR) operator to extract the \fBwchar_t\fR character or the attribute
+alone from any position in the \fIwchstr\fR (see \fBcurs_inwch\fR(3CURSES)).
+.SH RETURN VALUE
+.sp
+.LP
+All routines return the integer \fBERR\fR upon failure and an integer value
+other than \fBERR\fR upon successful completion.
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for a description of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i)
+lw(2.75i) |lw(2.75i)
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+MT-LevelUnsafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBcurses\fR(3CURSES), \fBcurs_inwch\fR(3CURSES), \fBattributes\fR(5)
+.SH NOTES
+.sp
+.LP
+The header file <\fBcurses.h\fR> automatically includes the header files
+<\fBstdio.h\fR>, <\fBunctrl.h\fR> and <\fBwidec.h\fR>.
+.sp
+.LP
+Note that all routines except \fBwinwchnstr()\fR may be macros.
+.sp
+.LP
+None of these routines can use the color attribute in \fBchtype\fR.