Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard

See Also

attroff(3XCURSES), can_change_color(3XCURSES), libcurses(3XCURSES), setcchar(3XCURSES), attributes(7), standards(7)