usr/src/man/man3xcurses/setcchar.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 SETCCHAR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 setcchar \- set a cchar_t type character from a wide character and rendition
   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 \fBsetcchar\fR(\fBcchar_t *\fR\fIwcval\fR, \fBconst wchar_t *\fR\fIwch\fR, \fBconst attr_t\fR \fIattrs\fR,
  20      \fBshort\fR \fIcolor_pair\fR, \fBconst void *\fR\fIopts\fR);
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIwcval\fR\fR
  28 .ad
  29 .RS 14n
  30 Is a pointer to a location where a \fBcchar_t\fR character (and its  rendition)
  31 can be stored.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIwch\fR\fR
  38 .ad
  39 .RS 14n
  40 Is a pointer to a wide character.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIattrs\fR\fR
  47 .ad
  48 .RS 14n
  49 Is the set of attributes to apply to \fIwch\fR in creating \fIwcval\fR.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIcolor_pair\fR\fR
  56 .ad
  57 .RS 14n
  58 Is the color pair to apply to \fIwch\fR in creating \fIwcval\fR.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIopts\fR\fR
  65 .ad
  66 .RS 14n
  67 Is reserved for future use. Currently, this must be a null pointer.
  68 .RE
  69
  70 .SH DESCRIPTION
  71 .sp
  72 .LP
  73 The \fBsetcchar()\fR function takes the wide character pointed to by \fIwch\fR,
  74 combines it with the attributes indicated by \fIattrs\fR and the color pair
  75 indicated by \fIcolor_pair\fR and stores the result in the object pointed to by
  76 \fIwcval\fR.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 On success, the \fBsetcchar()\fR function returns \fBOK\fR. Otherwise, it
  81 returns \fBERR\fR.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 None.
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 _
 101 MT-Level        Unsafe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBattroff\fR(3XCURSES), \fBcan_change_color\fR(3XCURSES),
 108 \fBgetcchar\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
 109 \fBstandards\fR(5)