| 1 | .\"***************************************************************************
|
|---|
| 2 | .\" Copyright (c) 2002-2004,2005 Free Software Foundation, Inc. *
|
|---|
| 3 | .\" *
|
|---|
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|---|
| 5 | .\" copy of this software and associated documentation files (the *
|
|---|
| 6 | .\" "Software"), to deal in the Software without restriction, including *
|
|---|
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, *
|
|---|
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell *
|
|---|
| 9 | .\" copies of the Software, and to permit persons to whom the Software is *
|
|---|
| 10 | .\" furnished to do so, subject to the following conditions: *
|
|---|
| 11 | .\" *
|
|---|
| 12 | .\" The above copyright notice and this permission notice shall be included *
|
|---|
| 13 | .\" in all copies or substantial portions of the Software. *
|
|---|
| 14 | .\" *
|
|---|
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|---|
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|---|
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|---|
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|---|
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|---|
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|---|
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|---|
| 22 | .\" *
|
|---|
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright *
|
|---|
| 24 | .\" holders shall not be used in advertising or otherwise to promote the *
|
|---|
| 25 | .\" sale, use or other dealings in this Software without prior written *
|
|---|
| 26 | .\" authorization. *
|
|---|
| 27 | .\"***************************************************************************
|
|---|
| 28 | .\"
|
|---|
| 29 | .\" $Id: curs_inwstr.3x,v 1.4 2005/06/25 18:31:26 Daniel.Jacobowitz Exp $
|
|---|
| 30 | .TH curs_inwstr 3X ""
|
|---|
| 31 | .SH NAME
|
|---|
| 32 | \fBinwstr\fR,
|
|---|
| 33 | \fBinnwstr\fR,
|
|---|
| 34 | \fBwinwstr\fR,
|
|---|
| 35 | \fBwinnwstr\fR,
|
|---|
| 36 | \fBmvinwstr\fR,
|
|---|
| 37 | \fBmvinnwstr\fR,
|
|---|
| 38 | \fBmvwinwstr\fR,
|
|---|
| 39 | \fBmvwinnwstr\fR \- get a string of \fBwchar_t\fR characters from a curses window
|
|---|
| 40 | .SH SYNOPSIS
|
|---|
| 41 | .nf
|
|---|
| 42 | \fB#include <curses.h> \fR
|
|---|
| 43 |
|
|---|
| 44 | \fBint inwstr(\fR\fBwchar_t *\fR\fIstr\fR\fB);\fR
|
|---|
| 45 | .br
|
|---|
| 46 | \fBint innwstr(\fR\fBwchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 47 | .br
|
|---|
| 48 | \fBint winwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIstr\fR\fB);\fR
|
|---|
| 49 | .br
|
|---|
| 50 | \fBint winnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 51 | .br
|
|---|
| 52 | \fBint mvinwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB);\fR
|
|---|
| 53 | .br
|
|---|
| 54 | \fBint mvinnwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 55 | .br
|
|---|
| 56 | \fBint mvwinwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB);\fR
|
|---|
| 57 | .br
|
|---|
| 58 | \fBint mvwinnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 59 | .fi
|
|---|
| 60 | .SH DESCRIPTION
|
|---|
| 61 | These routines return a string of \fBwchar_t\fR characters in \fIwstr\fR,
|
|---|
| 62 | extracted starting at the current cursor position in the named window.
|
|---|
| 63 | Attributes are stripped from the characters.
|
|---|
| 64 | The four functions with \fIn\fR as the last argument return a leading substring at most
|
|---|
| 65 | \fIn\fR bytes long (exclusive of the trailing NUL).
|
|---|
| 66 | Transfer stops at the end of the current line, or when \fIn\fR bytes have
|
|---|
| 67 | been stored at the location referenced by \fIwstr\fR.
|
|---|
| 68 | .PP
|
|---|
| 69 | If the size \fIn\fR is not large enough to store a complete character,
|
|---|
| 70 | an error is generated.
|
|---|
| 71 | .SH NOTES
|
|---|
| 72 | Note that all routines except
|
|---|
| 73 | \fBwinnwstr\fR
|
|---|
| 74 | may be macros.
|
|---|
| 75 | .SH RETURN VALUES
|
|---|
| 76 | All routines return
|
|---|
| 77 | \fBERR\fR
|
|---|
| 78 | upon failure. Upon
|
|---|
| 79 | successful completion, the *\fBinwstr\fR
|
|---|
| 80 | routines return
|
|---|
| 81 | \fBOK\fR, and the *\fBinnwstr\fR
|
|---|
| 82 | routines return the
|
|---|
| 83 | number of characters read into the string.
|
|---|
| 84 | .SH SEE ALSO
|
|---|
| 85 | Functions:
|
|---|
| 86 | \fBcurses\fR(3X),
|
|---|
| 87 | \fBcurs_instr\fR(3X),
|
|---|
| 88 | \fBcurs_in_wchstr\fR(3X)
|
|---|
| 89 | .\"#
|
|---|
| 90 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 91 | .\"# Local Variables:
|
|---|
| 92 | .\"# mode:nroff
|
|---|
| 93 | .\"# fill-column:79
|
|---|
| 94 | .\"# End:
|
|---|
