lib/libncurses/man/curs_in_wchstr.3x

   1 .\"***************************************************************************
   2 .\" Copyright (c) 2002-2010,2012 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_in_wchstr.3x,v 1.9 2012/11/03 23:03:59 tom Exp $
  30 .TH curs_in_wchstr 3X ""
  31 .na
  32 .hy 0
  33 .SH NAME
  34 \fBin_wchstr\fR,
  35 \fBin_wchnstr\fR,
  36 \fBwin_wchstr\fR,
  37 \fBwin_wchnstr\fR,
  38 \fBmvin_wchstr\fR,
  39 \fBmvin_wchnstr\fR,
  40 \fBmvwin_wchstr\fR,
  41 \fBmvwin_wchnstr\fR \- get an array of complex characters and renditions from a curses window
  42 .ad
  43 .hy
  44 .SH SYNOPSIS
  45 .nf
  46 \fB#include <curses.h>\fR
  47 .sp
  48 \fBint in_wchstr(cchar_t *\fR\fIwchstr\fR\fB);\fR
  49 .br
  50 \fBint in_wchnstr(cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
  51 .br
  52 \fBint win_wchstr(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR
  53 .br
  54 \fBint win_wchnstr(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
  55 .br
  56 \fBint mvin_wchstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR
  57 .br
  58 \fBint mvin_wchnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
  59 .br
  60 \fBint mvwin_wchstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR
  61 .br
  62 \fBint mvwin_wchnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR, int \fIn\fR\fB);\fR
  63 .fi
  64 .SH DESCRIPTION
  65 These functions return an array of complex characters in \fIwchstr\fR,
  66 starting at the current cursor position in the named window.
  67 Attributes (rendition) are stored with the characters.
  68 .PP
  69 The
  70 \fBin_wchnstr\fR,
  71 \fBmvin_wchnstr\fR,
  72 \fBmvwin_wchnstr\fR
  73 and
  74 \fBwin_wchnstr\fR
  75 fill the array
  76 with at most
  77 \fIn\fR
  78 \fBcchar_t\fR
  79 elements.
  80 .br
  81 .SH NOTES
  82 Note that all routines except
  83 \fBwin_wchnstr\fR
  84 may be
  85 macros.
  86 .PP
  87 Reading a line that overflows the array pointed to by
  88 \fIwchstr\fR
  89 with
  90 \fBin_wchstr\fR,
  91 \fBmvin_wchstr\fR,
  92 \fBmvwin_wchstr\fR
  93 or
  94 \fBwin_wchstr\fR
  95 causes undefined results. Therefore, the use of
  96 \fBin_wchnstr\fR,
  97 \fBmvin_wchnstr\fR,
  98 \fBmvwin_wchnstr\fR, or
  99 \fBwin_wchnstr\fR
 100 is recommended.
 101 .SH RETURN VALUE
 102 Upon successful completion, these functions return
 103 \fBOK\fR.
 104 Otherwise, they return
 105 \fBERR\fR.
 106 .PP
 107 Functions with a "mv" prefix first perform a cursor movement using
 108 \fBwmove\fP, and return an error if the position is outside the window,
 109 or if the window pointer is null.
 110 .SH PORTABILITY
 111 The XSI Curses defines no error conditions.
 112 This implementation checks for null pointers,
 113 returning ERR in that case.
 114 .SH SEE ALSO
 115 Functions:
 116 \fBcurses\fR(3X),
 117 \fBcurs_in_wch\fR(3X),
 118 \fBcurs_instr\fR(3X),
 119 \fBcurs_inwstr\fR(3X)
 120 \fBcurs_inchstr\fR(3X)