usr/src/man/man3xcurses/in_wchnstr.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH IN_WCHNSTR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 in_wchnstr, in_wchstr, mvin_wchnstr, mvin_wchstr, mvwin_wchnstr, mvwin_wchstr,
   9 win_wchnstr, win_wchstr \- retrieve complex character string (with rendition)
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBin_wchnstr\fR(\fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBin_wchstr\fR(\fBcchar_t *\fR\fIwchstr\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvin_wchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvin_wchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBmvwin_wchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBmvwin_wchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwin_wchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwin_wchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwchstr\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBin_wchstr()\fR and \fBwin_wchstr()\fR functions retrieve a complex
  62 character string (with rendition) starting at the current cursor position of
  63 the \fBstdscr\fR window and window \fIwin\fR, respectively, and ending at  the
  64 right margin. The \fBmvin_wchstr()\fR and \fBmvwin_wchstr()\fR functions
  65 retrieve a complex character string located at the position indicated by the
  66 \fIx\fR  (column) and \fIy\fR (row) parameters (the former in the \fBstdscr\fR
  67 window; the latter in window \fIwin\fR).
  68 .sp
  69 .LP
  70 The \fBin_wchnstr()\fR, \fBwin_wchnstr()\fR, \fBmvin_wchnstr()\fR, and
  71 \fBmvwin_wchnstr()\fR functions retrieve at most \fIn\fR characters from the
  72 window \fBstdscr\fR and \fIwin\fR, respectively. The former two functions
  73 retrieve the string, starting at the current cursor  position; the latter two
  74 commands retrieve the string, starting at the position  specified by the
  75 \fIx\fR and \fIy\fR parameters.
  76 .sp
  77 .LP
  78 The retrieved character string (with renditions) is stored in the object
  79 pointed to by \fIwcval\fR.
  80 .SH PARAMETERS
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fIwchstr\fR\fR
  85 .ad
  86 .RS 10n
  87 Is a pointer to an object where the retrieved complex character string can be
  88 stored.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fIn\fR\fR
  95 .ad
  96 .RS 10n
  97 Is the number of characters not to exceed when retrieving \fIwchstr\fR.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fIy\fR\fR
 104 .ad
 105 .RS 10n
 106 Is the y (row) coordinate of the starting position of the string to be
 107 retrieved.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fIx\fR\fR
 114 .ad
 115 .RS 10n
 116 Is the x (column) coordinate of the starting position of the string to be
 117 retrieved.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fIwin\fR\fR
 124 .ad
 125 .RS 10n
 126 Is a pointer to the window in which the string is to be retrieved.
 127 .RE
 128
 129 .SH RETURN VALUES
 130 .sp
 131 .LP
 132 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 133 .SH ERRORS
 134 .sp
 135 .LP
 136 None.
 137 .SH ATTRIBUTES
 138 .sp
 139 .LP
 140 See \fBattributes\fR(5) for descriptions of the following attributes:
 141 .sp
 142
 143 .sp
 144 .TS
 145 box;
 146 c | c
 147 l | l .
 148 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 149 _
 150 Interface Stability     Standard
 151 _
 152 MT-Level        Unsafe
 153 .TE
 154
 155 .SH SEE ALSO
 156 .sp
 157 .LP
 158 \fBin_wch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
 159 \fBstandards\fR(5)