xref: /illumos-gate/usr/src/man/man3xcurses/setcchar.3xcurses (revision 66582b606a8194f7f3ba5b3a3a6dca5b0d346361)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
SETCCHAR 3XCURSES "Jun 5, 2002"
NAME
setcchar - set a cchar_t type character from a wide character and rendition
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int setcchar(cchar_t *wcval, const wchar_t *wch, const attr_t attrs,
 short color_pair, const void *opts);
PARAMETERS
wcval

Is a pointer to a location where a cchar_t character (and its rendition) can be stored.

wch

Is a pointer to a wide character.

attrs

Is the set of attributes to apply to wch in creating wcval.

color_pair

Is the color pair to apply to wch in creating wcval.

opts

Is reserved for future use. Currently, this must be a null pointer.

DESCRIPTION

The setcchar() function takes the wide character pointed to by wch, combines it with the attributes indicated by attrs and the color pair indicated by color_pair and stores the result in the object pointed to by wcval.

RETURN VALUES

On success, the setcchar() function returns OK. Otherwise, it returns ERR.

ERRORS

None.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

attroff(3XCURSES), can_change_color(3XCURSES), getcchar(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)