X/Open Curses Library Functions                getcchar(3XCURSES)



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

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

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

     #include 

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


DESCRIPTION
     If wch is not a null pointer, the getcchar() function splits
     the   cchart object pointed to by wcval into a wide charac-
     ter 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 colorpair, 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 cchart object
     pointed to by  wcval. The objects pointed to  by  attrs  and
     colorpair are not changed.

PARAMETERS
     wcval         Is a pointer to a cchart object.


     wch           Is a pointer to an object where a wide charac-
                   ter string can be stored.


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


     colorpair    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




SunOS 5.11           Last change: 5 Jun 2002                    1






X/Open Curses Library Functions                getcchar(3XCURSES)



     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 ER otherwise.

ERORS
     None

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Standard                    
    
     MT-Level                     Unsafe                      
    


SEE ALSO
     attroff(3XCURSES),               canchangecolor(3XCURSES),
     libcurses(3XCURSES),    setcchar(3XCURSES),   attributes(5),
     standards(5)

























SunOS 5.11           Last change: 5 Jun 2002                    2