ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / curs_getcchar.3x.html
index 224cbc6613357e0ba7f248591ff71ec91caf97d6..73597971cc9650d294451fa788635da29a8324e2 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2001-2012,2015 Free Software Foundation, Inc.              *
+  * Copyright (c) 2001-2015,2017 Free Software Foundation, Inc.              *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -26,7 +26,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_getcchar.3x,v 1.17 2015/07/21 09:30:38 tom Exp @
+  * @Id: curs_getcchar.3x,v 1.18 2017/03/31 10:50:54 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
            allowed.
 
 
-</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       The  <EM>opts</EM> argument is reserved for future use.  Currently,
-       an application must provide a null pointer as <EM>opts</EM>.
+</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
+       X/Open  Curses documents the <EM>opts</EM> 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:
+
+       <STRONG>o</STRONG>   For   functions   which  modify the color, e.g., <STRONG>setc-</STRONG>
+           <STRONG>char</STRONG>, if <EM>opts</EM> is set it is treated  as  a  pointer  to
+           <STRONG>int</STRONG>,  and used to  set  the  color pair instead of the
+           <STRONG>short</STRONG> pair parameter.
+
+       <STRONG>o</STRONG>   For functions which retrieve the  color,  e.g.,  <STRONG>getc-</STRONG>
+           <STRONG>char</STRONG>,  if  <EM>opts</EM>  is  set it is treated as a pointer to
+           <STRONG>int</STRONG>, and  used  to  retrieve  the color pair as an <STRONG>int</STRONG>
+           value,  in  addition  retrieving  it  via the standard
+           pointer to <STRONG>short</STRONG> parameter.
 
+
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        The <EM>wcval</EM> argument may be a value generated by a  call  to
        <STRONG>setcchar</STRONG>  or by a function that has a <STRONG>cchar_t</STRONG> output argu-
        ment.  If <EM>wcval</EM> is constructed by  any  other  means,  the
 <li><a href="#h3-setcchar">setcchar</a></li>
 </ul>
 </li>
+<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
 <li><a href="#h2-NOTES">NOTES</a></li>
 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>