ncurses 5.7 - patch 20100109

[ncurses.git] / doc / html / man / curs_getcchar.3x.html
diff --git a/doc/html/man/curs_getcchar.3x.html b/doc/html/man/curs_getcchar.3x.html

index d6e961f4b93d00a978c768d26635211fcf087eca..1358430cbc2f9d5239c9446a8a71836db5b14416 100644 (file)
--- a/doc/html/man/curs_getcchar.3x.html
+++ b/doc/html/man/curs_getcchar.3x.html
@@ -1,7 +1,7 @@
  <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  <!-- 
    ****************************************************************************
-  * Copyright (c) 2001-2003,2006 Free Software Foundation, Inc.              *
+  * Copyright (c) 2001-2008,2009 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            *
@@ -27,7 +27,7 @@
    * sale, use or other dealings in this Software without prior written       *
    * authorization.                                                           *
    ****************************************************************************
-  * @Id: curs_getcchar.3x,v 1.8 2006/07/15 22:51:07 wcmbrine Exp @
+  * @Id: curs_getcchar.3x,v 1.12 2009/07/18 16:10:56 tom Exp @
  -->
  <HTML>
  <HEAD>
@@ -106,26 +106,32 @@
  
         -    The wide-character string pointed  to  by  <EM>wch</EM>.   The
              string  must be L'\0' terminated, contain at most one
-            character with strictly positive width, which must be
-            the  first,  and  contain  no  characters of negative
-            width.
+            spacing character, which must be the first.
+
+            Up to <STRONG>CCHARW_MAX</STRONG>-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.
  
  
  </PRE>
  <H2>NOTES</H2><PRE>
-       The <EM>opts</EM> argument is reserved for future use.   Currently,
+       The  <EM>opts</EM> argument is reserved for future use.  Currently,
         an application must provide a null pointer as <EM>opts</EM>.
  
-       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
+       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
         effect is unspecified.
  
  
  </PRE>
  <H2>RETURN VALUES</H2><PRE>
         When <EM>wch</EM> is a null pointer, <STRONG>getcchar</STRONG> returns the number of
-       wide characters referenced by <EM>wcval</EM>.
+       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.
@@ -136,8 +142,8 @@
  
  </PRE>
  <H2>SEE ALSO</H2><PRE>
-       Functions:   <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  <STRONG><A HREF="wcwidth.3x.html">wcwidth(3x)</A></STRONG>,  <STRONG><A HREF="curs_attr_get.3x.html">curs_attr_get(3x)</A></STRONG>,
-       <STRONG><A HREF="can_change_color.3x.html">can_change_color(3x)</A></STRONG>.
+       Functions:   <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>,   <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>,  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
+       <STRONG><A HREF="wcwidth.3.html">wcwidth(3)</A></STRONG>.