X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=6bd64861116bca561f9f197c18a3a1a516cdcb05;hp=9f8ca2f0daf3ccdc3be593bf1042f3177ae273b5;hb=2e5d72d6396bb38a8d1d1b3534f62e28aebaa600;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index 9f8ca2f0..6bd64861 100644 --- a/doc/html/man/curs_getcchar.3x.html +++ b/doc/html/man/curs_getcchar.3x.html @@ -1,7 +1,7 @@ - + @@ -77,68 +77,73 @@ 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,
+       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, including the null
-       terminator.
+       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.
 
 
 

 
SEE ALSO
-       Functions:  curses(3x),  wcwidth(3x),   curs_attr_get(3x),
-       can_change_color(3x).
+       Functions:   curs_attr(3x),   curs_color(3x),  curses(3x),
+       wcwidth(3).