The getcchar function gets a wide-character string and
rendition from a cchar_t argument. When wch is not a null
pointer, the getcchar function does the following:
- - Extracts information from a cchar_t value wcval
+ o Extracts information from a cchar_t value wcval
- - Stores the character attributes in the location
- pointed to by attrs
+ o Stores the character attributes in the location
+ pointed to by attrs
- - Stores the color-pair in the location pointed to by
- color_pair
+ o Stores the color-pair in the location pointed to by
+ color_pair
- - Stores the wide-character string, characters refer-
- enced by wcval, into the array pointed to by wch.
+ o Stores the wide-character string, characters refer-
+ enced by wcval, into the array pointed to by wch.
When wch is a null pointer, the getcchar function does the
following:
- - Obtains the number of wide characters pointed to by
- wcval
+ o Obtains the number of wide characters pointed to by
+ wcval
- - Does not change the data referenced by attrs or
- color_pair
+ o Does not change the data referenced by attrs or
+ color_pair
+
+
The setcchar function initializes the location pointed to
by wcval by using:
- - The character attributes in attrs
+ o The character attributes in attrs
- - The color pair in color_pair
+ o The color pair in color_pair
- - The wide-character string pointed to by wch. The
- string must be L'\0' terminated, contain at most one
- spacing character, which must be the first.
+ o The wide-character string pointed to by wch. The
+ string must be L'\0' terminated, contain at most one
+ spacing character, which must be the first.
- Up to CCHARW_MAX-1 nonspacing characters may follow.
- Additional nonspacing characters are ignored.
+ Up to CCHARW_MAX-1 nonspacing characters may follow.
+ Additional nonspacing characters are ignored.
- The string may contain a single control character
- instead. In that case, no nonspacing characters are
- allowed.
+ The string may contain a single control character
+ instead. In that case, no nonspacing characters are
+ allowed.
-
The opts argument is reserved for future use. Currently,
an application must provide a null pointer as opts.
@@ -127,31 +127,40 @@
effect is unspecified.
-
When wch is a null pointer, getcchar returns the number of
- wide characters referenced by wcval.
+ wide characters referenced by wcval, including one for a
+ trailing null.
- When wch is not a null pointer, getcchar returns OK upon
+ When wch is not a null pointer, getcchar returns OK upon
successful completion, and ERR otherwise.
- Upon successful completion, setcchar returns OK. Other-
+ Upon successful completion, setcchar returns OK. Other-
wise, it returns ERR.
-