getcchar(3xcurses) [sunos man page]

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

NAME

       getcchar - get a wide character string (with rendition) from a cchar_t

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 getcchar(const cchar_t *wcval, wchar_t *wch, attr_t *attrs, short *color_pair, void *opt);

DESCRIPTION

       If  wch	is  not  a  null  pointer,  the  getcchar()  function splits the  cchar_t object pointed to by wcval into a wide character string,
       attributes, and a color pair. It stores the attributes in the location pointed to by attrs, the color  pair in the location pointed  to	by
       color_pair, and the wide character string in the location pointed to by wch.

       If wch is a null pointer, the getcchar() function simply returns  the number of wide characters in the cchar_t object pointed to by  wcval.
       The objects pointed to by attrs and color_pair are not changed.

PARAMETERS

       wcval	       Is a pointer to a cchar_t object.

       wch	       Is a pointer to an object where a wide character string can be stored.

       attrs	       Is a pointer to an object where attributes can be stored.

       color_pair      Is a pointer to an object where a color pair can be stored.

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

RETURN VALUES

       When wch is a null pointer, the getcchar() function returns the	number of wide characters in the string pointed to by wcval including  the
       null terminator.

       When wch is not a null pointer, the getcchar() function	returns  OK on success and ERR otherwise.

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), libcurses(3XCURSES), setcchar(3XCURSES), attributes(5), standards(5)

SunOS 5.10							    5 Jun 2002							getcchar(3XCURSES)

getcchar(3NCURSES)														getcchar(3NCURSES)

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:

       o   Extracts information from a cchar_t value wcval

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

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

       o   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:

       o   Obtains the number of wide characters pointed to by wcval

       o   Does not change the data referenced by attrs or color_pair

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

       o   The character attributes in attrs

       o   The color pair in color_pair

       o   The wide-character string pointed to by wch.  The string must be L'' terminated, contain at most one spacing character, which must be
	   the first.

	   Up to CCHARW_MAX-1 nonspacing characters may follow.  Additional nonspacing characters are ignored.

	   The string may contain a single control character instead.  In that case, no nonspacing characters are allowed.

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 one for a trailing null.

       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: attr(3NCURSES), color(3NCURSES), ncurses(3NCURSES), wcwidth(3).

																getcchar(3NCURSES)