getcchar(3xcurses)

1getcchar(3XCURSES)      X/Open Curses Library Functions     getcchar(3XCURSES)
2
3
4

NAME

6       getcchar - get a wide character string (with rendition) from a cchar_t
7

SYNOPSIS

9       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
10        -R  /usr/xpg4/lib  -lcurses  [ library... ]
11
12       c89 [ flag... ] file... -lcurses [ library... ]
13
14       #include <curses.h>
15
16       int getcchar(const cchar_t *wcval, wchar_t *wch, attr_t *attrs,
17            short *color_pair,void *opt);
18
19

DESCRIPTION

21       If  wch  is  not  a  null  pointer,  the getcchar() function splits the
22       cchar_t object pointed to  by  wcval  into  a  wide  character  string,
23       attributes,  and a color pair. It stores the attributes in the location
24       pointed to by attrs, the color  pair in  the  location  pointed  to  by
25       color_pair, and the wide character string in the location pointed to by
26       wch.
27
28
29       If wch is a null pointer, the getcchar() function simply  returns   the
30       number  of  wide characters in the cchar_t object pointed to by  wcval.
31       The objects pointed to by attrs and color_pair are not changed.
32

PARAMETERS

34       wcval         Is a pointer to a cchar_t object.
35
36
37       wch           Is a pointer to an object where a wide  character  string
38                     can be stored.
39
40
41       attrs         Is a pointer to an object where attributes can be stored.
42
43
44       color_pair    Is  a  pointer  to  an  object  where a color pair can be
45                     stored.
46
47
48       opts          Is reserved for future use. Currently,  this  must  be  a
49                     null pointer.
50
51

RETURN VALUES

53       When wch is a null pointer, the getcchar() function returns the  number
54       of wide characters in the string pointed to  by  wcval  including   the
55       null terminator.
56
57
58       When wch is not a null pointer, the getcchar() function  returns  OK on
59       success and ERR otherwise.
60

ERRORS

62       None
63

ATTRIBUTES

65       See attributes(5) for descriptions of the following attributes:
66
67
68
69
70       ┌─────────────────────────────┬─────────────────────────────┐
71       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
72       ├─────────────────────────────┼─────────────────────────────┤
73       │Interface Stability          │Standard                     │
74       ├─────────────────────────────┼─────────────────────────────┤
75       │MT-Level                     │Unsafe                       │
76       └─────────────────────────────┴─────────────────────────────┘
77