X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getcchar.3x.html;h=73597971cc9650d294451fa788635da29a8324e2;hp=967c34758b763981ce1a1223432c47d06b22cb8f;hb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;hpb=6a530b46563470c2ca73579d1994a0c8e275dd98 diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html index 967c3475..73597971 100644 --- a/doc/html/man/curs_getcchar.3x.html +++ b/doc/html/man/curs_getcchar.3x.html @@ -1,6 +1,6 @@ @@ -45,15 +45,13 @@ - -

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(
@@ -71,11 +69,9 @@
                void *opts );
 
 
-
-

DESCRIPTION

+

DESCRIPTION

 
-
-

getcchar

+

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 function does the following:
@@ -101,8 +97,7 @@
            color_pair
 
 
-
-

setcchar

+

setcchar

        The  setcchar function initializes the location pointed to
        by wcval by using:
 
@@ -122,19 +117,33 @@
            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 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.
+
+
+

NOTES

        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 VALUE

+

RETURN VALUE

        When wch is a null pointer, getcchar returns the number of
        wide characters referenced by wcval, including one  for  a
        trailing null.
@@ -146,8 +155,7 @@
        wise, it returns ERR.
 
 
-
-

SEE ALSO

+

SEE ALSO

        Functions:   curs_attr(3x),   curs_color(3x),  curses(3x),
        wcwidth(3).
 
@@ -165,6 +173,7 @@
 
  • setcchar
  • +
  • EXTENSIONS
  • NOTES
  • RETURN VALUE
  • SEE ALSO