X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=1f172ebf85994b54cb28927231ec1d68961da099;hb=32f9f5f12cd9159261f9db228461049e8c770404;hp=b55ce1d7dfbfaa406946710e08a43abf1b6ae691;hpb=ca276baf720e3a44721b9e18955d3f546955c6c8;p=ncurses.git diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index b55ce1d7..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

-
+

curs_getcchar 3x

-
 curs_getcchar(3x)                                     curs_getcchar(3x)
-

NAME

+
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,52 +72,52 @@
 
 
 

-
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
-            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.
 
 
 

-
NOTES
+
NOTES
        The  opts argument is reserved for future use.  Currently,
        an application must provide a null pointer as opts.
 
@@ -128,30 +128,36 @@
 
 
 

-
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
+       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:  curs_attr(3x),   curs_color(3x),   curses(3x),
-       wcwidth(3).
+
SEE ALSO
+       Functions:   curs_attr(3x),   curs_color(3x),  curses(3x),
+       wcwidth(3).
 
 
 
                                                       curs_getcchar(3x)
 

-

-

-Man(1) output converted with
-man2html
-

+

+
+