Current File : //usr/share/man/man3xcurses/getcchar.3xcurses

'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH getcchar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
getcchar \- get a wide character string (with rendition) from a cchar_t
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
 
#include <curses.h>

\fBint\fR \fBgetcchar\fR(\fBconst cchar_t *\fR\fIwcval\fR, \fBwchar_t *\fR\fIwch\fR, \fBattr_t *\fR\fIattrs\fR,
     \fBshort *\fR\fIcolor_pair\fR,\fBvoid *\fR\fIopt\fR);
.fi

.SH DESCRIPTION
.sp
.LP
If \fIwch\fR is not a null pointer, the \fBgetcchar()\fR function splits the  \fBcchar_t\fR object pointed to by \fIwcval\fR into a wide character string, attributes, and a color pair. It stores the attributes in the location pointed to by \fIattrs\fR, the color  pair in the location pointed to by \fIcolor_pair\fR, and the wide character string in the location pointed to by \fIwch\fR.
.sp
.LP
If \fIwch\fR is a null pointer, the \fBgetcchar()\fR function simply returns  the number of wide characters in the \fBcchar_t\fR object pointed to by  \fIwcval\fR. The objects pointed to by \fIattrs\fR and \fIcolor_pair\fR are not changed.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwcval\fR\fR
.ad
.RS 14n
.rt  
Is a pointer to a \fBcchar_t\fR object.
.RE

.sp
.ne 2
.mk
.na
\fB\fIwch\fR\fR
.ad
.RS 14n
.rt  
Is a pointer to an object where a wide character string can be stored.
.RE

.sp
.ne 2
.mk
.na
\fB\fIattrs\fR\fR
.ad
.RS 14n
.rt  
Is a pointer to an object where attributes can be stored.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcolor_pair\fR\fR
.ad
.RS 14n
.rt  
Is a pointer to an object where a color pair can be stored.
.RE

.sp
.ne 2
.mk
.na
\fB\fIopts\fR\fR
.ad
.RS 14n
.rt  
Is reserved for future use. Currently, this must be a null pointer.
.RE

.SH RETURN VALUES
.sp
.LP
When \fIwch\fR is a null pointer, the \fBgetcchar()\fR function returns the  number of wide characters in the string pointed to by \fIwcval\fR including  the null terminator.
.sp
.LP
When \fIwch\fR is not a null pointer, the \fBgetcchar()\fR function  returns  \fBOK\fR on success and \fBERR\fR otherwise.
.SH ERRORS
.sp
.LP
None
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBattroff\fR(3XCURSES), \fBcan_change_color\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBsetcchar\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)