X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=1f172ebf85994b54cb28927231ec1d68961da099;hp=235e41c9fb413d59a44fb9311246ec6a48d6f825;hb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86;hpb=f70db18a0c3c6a828d8a5999be37239f01c9d98a diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index 235e41c9..1f172ebf 100644 --- a/doc/html/man/curs_getcchar.3x.html +++ b/doc/html/man/curs_getcchar.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_getcchar(3x) curs_getcchar(3x)-
+NAME
getcchar, setcchar - Get a wide character string and ren- dition from a cchar_t or set a cchar_t from a wide-charac- ter string-SYNOPSIS
+SYNOPSIS
#include <curses.h> int getcchar( @@ -72,60 +72,66 @@-DESCRIPTION
+DESCRIPTION
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 - character with strictly positive width, which must be - the first, and contain no characters of negative - width. + 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. + + The string may contain a single control character + instead. In that case, no nonspacing characters are + allowed.-NOTES
- The opts argument is reserved for future use. Currently, +NOTES
+ The opts argument is reserved for future use. Currently, an application must provide a null pointer as opts. - The wcval argument may be a value generated by a call to - setcchar or by a function that has a cchar_t output argu- - ment. If wcval is constructed by any other means, the + The wcval argument may be a value generated by a call to + setcchar or by a function that has a cchar_t output argu- + ment. If wcval is constructed by any other means, the effect is unspecified.-RETURN VALUES
+RETURN VALUE
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 successful completion, and ERR otherwise. @@ -135,18 +141,23 @@-SEE ALSO
+SEE ALSO
Functions: curs_attr(3x), curs_color(3x), curses(3x), - wcwidth(3). + wcwidth(3). curs_getcchar(3x)-
- -Man(1) output converted with -man2html - +