X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=b0a1abf6e73b978f2078b1515da29a1fcabce0fa;hb=725169bda4d3b4c3fde0d4a94f76d017812c7ea6;hp=adee87eb87778cfc4e8a67777149076a1588e9a5;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index adee87eb..b0a1abf6 100644 --- a/doc/html/man/curs_getcchar.3x.html +++ b/doc/html/man/curs_getcchar.3x.html @@ -1,6 +1,6 @@ -
--curs_getcchar(3x) curs_getcchar(3x) +curs_getcchar(3x) Library calls curs_getcchar(3x)
- getcchar, setcchar - Get a wide character string and rendition from a - cchar_t or set a cchar_t from a wide-character string + getcchar, setcchar - convert between a wide-character string and a + curses complex character string
@@ -73,14 +73,14 @@
The getcchar function gets a wide-character string and rendition from a - cchar_t argument. When wch is not a null pointer, the getcchar func- - tion does the following: + cchar_t argument. When wch is not a null pointer, the getcchar + function does the following: o Extracts information from a cchar_t value wcval o Stores the character attributes in the location pointed to by attrs - o 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 o Stores the wide-character string, characters referenced by wcval, into the array pointed to by wch. @@ -104,27 +104,22 @@ 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 non-spacing characters may follow. Additional + non-spacing characters are ignored. The string may contain a single control character instead. In that - case, no nonspacing characters are allowed. + case, no non-spacing characters are allowed. -
- X/Open Curses documents the opts argument as reserved for future use, - saying that it must be null. This implementation uses that parameter - in ABI 6 for the functions which have a color-pair parameter to support - extended color pairs: +
+ When wch is a null pointer, getcchar returns the number of wide + characters referenced by wcval, including one for a trailing null. - o For functions which modify the color, e.g., setcchar, if opts is - set it is treated as a pointer to int, and used to set the color - pair instead of the short pair parameter. + When wch is not a null pointer, getcchar returns OK upon successful + completion, and ERR otherwise. - o For functions which retrieve the color, e.g., getcchar, if opts is - set it is treated as a pointer to int, and used to retrieve the - color pair as an int value, in addition retrieving it via the stan- - dard pointer to short parameter. + Upon successful completion, setcchar returns OK. Otherwise, it returns + ERR.
@@ -133,19 +128,24 @@ by any other means, the effect is unspecified. -
- When wch is a null pointer, getcchar returns the number of wide charac- - ters referenced by wcval, including one for a trailing null. +
+ X/Open Curses documents the opts argument as reserved for future use, + saying that it must be null. This implementation uses that parameter + in ABI 6 for the functions which have a color pair parameter to support + extended color pairs: - When wch is not a null pointer, getcchar returns OK upon successful - completion, and ERR otherwise. + o For functions which modify the color, e.g., setcchar, if opts is + set it is treated as a pointer to int, and used to set the color + pair instead of the short pair parameter. - Upon successful completion, setcchar returns OK. Otherwise, it returns - ERR. + o For functions which retrieve the color, e.g., getcchar, if opts is + set it is treated as a pointer to int, and used to retrieve the + color pair as an int value, in addition retrieving it via the + standard pointer to short parameter.
- The CCHARW_MAX symbol is specific to ncurses. X/Open Curses does not + The CCHARW_MAX symbol is specific to ncurses. X/Open Curses does not provide details for the layout of the cchar_t structure. It tells what data are stored in it: @@ -174,14 +174,14 @@ o HP-UX 10 uses an opaque structure with 28 bytes, which is large enough for the 6 wchar_t values. - o Solaris xpg4 curses uses a single array of 6 wchar_t values. + o Solaris xpg4 curses uses a single array of 6 wchar_t values. This implementation's cchar_t was defined in 1995 using 5 for the total of spacing and non-spacing characters (CCHARW_MAX). That was probably due to a misreading of the AIX 4 header files, because the X/Open Curses document was not generally available at that time. Later (in - 2002), this detail was overlooked when beginning to implement the func- - tions using the structure. + 2002), this detail was overlooked when beginning to implement the + functions using the structure. In practice, even four non-spacing characters may seem enough. X/Open Curses documents possible uses for non-spacing characters, including @@ -192,11 +192,11 @@
- Functions: curs_attr(3x), curs_color(3x), curses(3x), wcwidth(3). + curses(3x), curs_attr(3x), curs_color(3x), wcwidth(3) - curs_getcchar(3x) +ncurses 6.4 2024-03-16 curs_getcchar(3x)