Seth Woolley's Man Viewer

curs_getcchar(3X)                                            curs_getcchar(3X)



NAME
       getcchar,  setcchar  - Get a wide character string(3,n) and rendition from a
       cchar_t or set(7,n,1 builtins) a cchar_t from a wide-character string(3,n)

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(3,n) a wide-character string(3,n) and rendition from a
       cchar_t  argument.   When wch is not a null pointer, the getcchar func-
       tion does the following:

       -    Extracts information from a cchar_t value wcval

       -    Stores the character attributes in(1,8)  the  location  pointed  to  by
            attrs

       -    Stores the color-pair in(1,8) the location pointed to by color_pair

       -    Stores  the wide-character string(3,n), 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(1,8) attrs

       -    The color pair in(1,8) color_pair

       -    The  wide-character  string(3,n) pointed to by wch.  The string(3,n) must be
            L'\0' terminated, contain at most one character with strictly pos-
            itive width, which must be the first, and contain no characters of
            negative width.

NOTES
       The opts argument is reserved for future use.  Currently,  an  applica-
       tion 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 constructed
       by any other means, the effect is unspecified.

RETURN VALUES
       When wch is a null pointer, getcchar returns the number of wide charac-
       ters 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)