X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=73597971cc9650d294451fa788635da29a8324e2;hb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;hp=22cb819fbd3d62575b674e2dff7b528f504b166a;hpb=3a935d9991cdf43ebfa952073c9b555f73a3e011;p=ncurses.git diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index 22cb819f..73597971 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) --
+
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 --
+
#include <curses.h> int getcchar( @@ -71,8 +69,9 @@ void *opts ); --
+
+ +
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: @@ -97,6 +96,8 @@ o Does not change the data referenced by attrs or color_pair + +
The setcchar function initializes the location pointed to by wcval by using: @@ -116,19 +117,33 @@ allowed. --
- The opts argument is reserved for future use. Currently, - an application must provide a null pointer as opts. +
+ X/Open Curses documents the opts argument as reserved for + future use, saying that it must be null. This implementa- + tion uses that parameter in ABI 6 for the functions which + have a color-pair parameter to support extended color + pairs: + o For functions which modify the color, e.g., setc- + char, 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. + + o For functions which retrieve the color, e.g., getc- + char, 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 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. --
+
When wch is a null pointer, getcchar returns the number of wide characters referenced by wcval, including one for a trailing null. @@ -140,19 +155,29 @@ wise, it returns ERR. --
+
Functions: curs_attr(3x), curs_color(3x), curses(3x), - wcwidth(3). + wcwidth(3). curs_getcchar(3x)-