getcchar(3curses)

getcchar -- get a wide character string and rendition from a cchar_t

Synopsis

cc [options] file -lcurses

#include <curses.h>

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

Description

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

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

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(3curses) returns the number of wide characters referenced by wcval, including the null terminator.

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

Errors

No errors are defined.

Usage

The wcval argument may be a value generated by a call to setcchar(3curses) or by a function that has a cchar_t output argument. If wcval is constructed by any other means, the effect is unspecified.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

attroff(3curses), can_change_color(3curses), setcchar(3curses), curses(4)