setcchar(3xcurses) [opensolaris man page]

setcchar(3XCURSES)					  X/Open Curses Library Functions					setcchar(3XCURSES)

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 
	-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)

SunOS 5.11							    5 Jun 2002							setcchar(3XCURSES)

curs_getcchar(3X)														 curs_getcchar(3X)

NAME

       getcchar, setcchar - Get a wide character string and rendition from a cchar_t or set a cchar_t from a wide-character string

SYNOPSIS

       #include <curses.h>

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

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

DESCRIPTION

       The  getcchar  function	gets  a wide-character string and rendition from a cchar_t argument.  When wch is not a null pointer, the getcchar
       function does the following:

       -    Extracts information from a cchar_t value wcval

       -    Stores the character attributes in the location pointed to by attrs

       -    Stores the color-pair in the location pointed to by color_pair

       -    Stores the wide-character string, characters referenced by wcval, into the array pointed to by wch.

       When wch is a null pointer, the getcchar function does the following:

       -    Obtains the number of wide characters pointed to by wcval

       -    Does not change the data referenced by attrs or color_pair

       The setcchar function initializes the location pointed to by wcval by using:

       -    The character attributes in attrs

       -    The color pair in color_pair

       -    The wide-character string pointed to by wch.  The string must be L'' terminated, contain at most one character with  strictly  posi-
	    tive width, which must be the first, and contain no characters of negative width.

NOTES

       The opts argument is reserved for future use.  Currently, an application must provide a null pointer as opts.

       The  wcval  argument  may be a value generated by a call to setcchar or by a function that has a cchar_t output argument.  If wcval is con-
       structed by any other means, the effect is unspecified.

RETURN VALUES

       When wch is a null pointer, getcchar returns the number of wide characters referenced by wcval, including the null terminator.

       When wch is not a null pointer, getcchar returns OK upon successful completion, and ERR otherwise.

       Upon successful completion, setcchar returns OK.  Otherwise, it returns ERR.

SEE ALSO

       Functions: curses(3X), wcwidth(3X), curs_attr_get(3X), can_change_color(3X).

																 curs_getcchar(3X)