ncurses 6.2 - patch 20210522
[ncurses.git] / doc / html / man / curs_getcchar.3x.html
index 504f54a733bbc1da75a4875e4d30d2af5802b901..6a45e0ac81214ab41467828f1247286c6de66228 100644 (file)
@@ -1,6 +1,7 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2001-2017,2019 Free Software Foundation, Inc.              *
+  * Copyright 2019,2020 Thomas E. Dickey                                     *
+  * Copyright 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 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_getcchar.3x,v 1.23 2019/11/30 22:22:32 tom Exp @
+  * @Id: curs_getcchar.3x,v 1.24 2020/02/02 23:34:34 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
@@ -72,8 +73,8 @@
 
 </PRE><H3><a name="h3-getcchar">getcchar</a></H3><PRE>
        The <STRONG>getcchar</STRONG> function gets a wide-character string and rendition from a
-       <STRONG>cchar_t</STRONG>  argument.   When <EM>wch</EM> is not a null pointer, the <STRONG>getcchar</STRONG> func-
-       tion does the following:
+       <STRONG>cchar_t</STRONG>  argument.   When  <EM>wch</EM>  is  not  a  null  pointer, the <STRONG>getcchar</STRONG>
+       function does the following:
 
        <STRONG>o</STRONG>   Extracts information from a <STRONG>cchar_t</STRONG> value <EM>wcval</EM>
 
 
        <STRONG>o</STRONG>   For  functions which retrieve the color, e.g., <STRONG>getcchar</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 stan-
-           dard pointer to <STRONG>short</STRONG> parameter.
+           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>
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of wide charac-
-       ters referenced by <EM>wcval</EM>, including one for a trailing null.
+       When <EM>wch</EM> is a  null  pointer,  <STRONG>getcchar</STRONG>  returns  the  number  of  wide
+       characters referenced by <EM>wcval</EM>, including one for a trailing null.
 
        When  <EM>wch</EM>  is  not  a null pointer, <STRONG>getcchar</STRONG> returns <STRONG>OK</STRONG> upon successful
        completion, and <STRONG>ERR</STRONG> otherwise.
        of  spacing and non-spacing characters (<STRONG>CCHARW_MAX</STRONG>).  That was probably
        due to a misreading of the  AIX 4  header  files,  because  the  X/Open
        Curses  document  was  not generally available at that time.  Later (in
-       2002), this detail was overlooked when beginning to implement the func-
-       tions using the structure.
+       2002), this detail was  overlooked  when  beginning  to  implement  the
+       functions using the structure.
 
        In  practice, even four non-spacing characters may seem enough.  X/Open
        Curses documents possible uses for  non-spacing  characters,  including