X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=ecc6ba7c385f077633de8dc28728c1549f10d772;hp=c35be69c69242f25eceed1b009848b00b4d12336;hb=8f6d94b8d6211a2323caef53fa4c96c475ec9a62;hpb=e2d7d0028f4298dca2b0edaf2dc8ce30518d9218 diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index c35be69c..ecc6ba7c 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)
+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
+

NAME

+       getcchar,  setcchar  - Get a wide character string and rendition from a
+       cchar_t or set a cchar_t from a wide-character string
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
        int getcchar(
@@ -68,91 +65,106 @@
                const wchar_t *wch,
                const attr_t attrs,
                short color_pair,
-               void *opts );
+               const void *opts );
 
 
-
-

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:
+

DESCRIPTION

+
+

getcchar

+       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:
 
        o   Extracts information from a cchar_t value wcval
 
-       o   Stores   the  character  attributes  in  the  location
-           pointed to by attrs
+       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.
 
-       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:
 
-       When wch is a null pointer, the getcchar function does the
-       following:
+       o   Obtains the number of wide characters pointed to by wcval
 
-       o   Obtains  the  number  of wide characters pointed to by
-           wcval
+       o   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:
+

setcchar

+       The  setcchar  function initializes the location pointed to by wcval by
+       using:
 
        o   The character attributes in attrs
 
        o   The color pair in color_pair
 
-       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.
+       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

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

EXTENSIONS

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

RETURN VALUE

-       When wch is a null pointer, getcchar returns the number of
-       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.
+

NOTES

+       The wcval argument may be a value generated by a call to setcchar or by
+       a function that has a cchar_t output argument.  If wcval is constructed
+       by any other means, the effect is unspecified.
 
-       Upon successful completion, setcchar returns  OK.   Other-
-       wise, it returns ERR.
 
+

RETURN VALUE

+       When wch is a null pointer, getcchar returns the number of wide charac-
+       ters referenced by wcval, including one for a trailing null.
 
-
-

SEE ALSO

-       Functions:   curs_attr(3x),   curs_color(3x),  curses(3x),
-       wcwidth(3).
+       When  wch  is  not  a null pointer, getcchar returns OK upon successful
+       completion, and ERR otherwise.
+
+       Upon successful completion, setcchar returns OK.  Otherwise, it returns
+       ERR.
+
+
+

SEE ALSO

+       Functions: curs_attr(3x), curs_color(3x), curses(3x), wcwidth(3).
 
 
 
-                                                      curs_getcchar(3x)
+                                                             curs_getcchar(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +