getcchar(3X)                                                   getcchar(3X)

NAME
     getcchar - get a wide character string and rendition from a cchart

SYNOPSIS
     cc [flag ...] file ... -lcurses [library ...]

     #include <curses.h>

     int getcchar(const cchart *wcval, wchart *wch, attrt *attrs,
            short *colorpair, void *opts);

DESCRIPTION
     When wch is not a null pointer, the getcchar() function extracts
     information from a cchart defined by wcval, stores the character
     attributes in the object pointed to by attrs, stores the colour pair
     in the object pointed to by colorpair, and stores the wide character
     string referenced by wcval into the array pointed to by wch.

     When wch is a null pointer, getcchar() obtains the number of wide
     characters in the object pointed to by wcval and does not change the
     objects pointed to by attrs or colorpair.

     The opts argument is reserved for definition in a future edition of
     this document. Currently, the application must provide a null pointer
     as opts.

RETURN VALUE
     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.

ERRORS
     No errors are defined.

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

SEE ALSO
     attroff(3X), canchangecolor(3X), curses(3X), setcchar(3X),
     curses(5).











Page 1                       Reliant UNIX 5.44                Printed 11/98