usr/src/man/man3xcurses/getcchar.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 GETCCHAR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 getcchar \- get a wide character string (with rendition) from a cchar_t
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBgetcchar\fR(\fBconst cchar_t *\fR\fIwcval\fR, \fBwchar_t *\fR\fIwch\fR, \fBattr_t *\fR\fIattrs\fR,
  20      \fBshort *\fR\fIcolor_pair\fR,\fBvoid *\fR\fIopt\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 If \fIwch\fR is not a null pointer, the \fBgetcchar()\fR function splits the
  27 \fBcchar_t\fR object pointed to by \fIwcval\fR into a wide character string,
  28 attributes, and a color pair. It stores the attributes in the location pointed
  29 to by \fIattrs\fR, the color  pair in the location pointed to by
  30 \fIcolor_pair\fR, and the wide character string in the location pointed to by
  31 \fIwch\fR.
  32 .sp
  33 .LP
  34 If \fIwch\fR is a null pointer, the \fBgetcchar()\fR function simply returns
  35 the number of wide characters in the \fBcchar_t\fR object pointed to by
  36 \fIwcval\fR. The objects pointed to by \fIattrs\fR and \fIcolor_pair\fR are not
  37 changed.
  38 .SH PARAMETERS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIwcval\fR\fR
  43 .ad
  44 .RS 14n
  45 Is a pointer to a \fBcchar_t\fR object.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIwch\fR\fR
  52 .ad
  53 .RS 14n
  54 Is a pointer to an object where a wide character string can be stored.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIattrs\fR\fR
  61 .ad
  62 .RS 14n
  63 Is a pointer to an object where attributes can be stored.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIcolor_pair\fR\fR
  70 .ad
  71 .RS 14n
  72 Is a pointer to an object where a color pair can be stored.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fIopts\fR\fR
  79 .ad
  80 .RS 14n
  81 Is reserved for future use. Currently, this must be a null pointer.
  82 .RE
  83
  84 .SH RETURN VALUES
  85 .sp
  86 .LP
  87 When \fIwch\fR is a null pointer, the \fBgetcchar()\fR function returns the
  88 number of wide characters in the string pointed to by \fIwcval\fR including
  89 the null terminator.
  90 .sp
  91 .LP
  92 When \fIwch\fR is not a null pointer, the \fBgetcchar()\fR function  returns
  93 \fBOK\fR on success and \fBERR\fR otherwise.
  94 .SH ERRORS
  95 .sp
  96 .LP
  97 None
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Standard
 112 _
 113 MT-Level        Unsafe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBattroff\fR(3XCURSES), \fBcan_change_color\fR(3XCURSES),
 120 \fBlibcurses\fR(3XCURSES), \fBsetcchar\fR(3XCURSES), \fBattributes\fR(5),
 121 \fBstandards\fR(5)