ncurses 6.1 - patch 20190713
[ncurses.git] / doc / html / man / curs_get_wstr.3x.html
index 36ad16b1d5c30ba4ef2f214f2707a5c106cd31f9..0e47dcc2e11ce0eb91c132a0f387c85e01c45951 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2002-2012,2017 Free Software Foundation, Inc.              *
+  * Copyright (c) 2002-2017,2018 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            *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_get_wstr.3x,v 1.11 2017/03/04 21:24:04 tom Exp @
+  * @Id: curs_get_wstr.3x,v 1.16 2018/09/01 20:58:10 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>curs_get_wstr 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        These functions are described in The Single Unix Specification, Version
-       2.   No  error conditions are defined.  This implementation returns ERR
+       2.   No  error conditions are defined.  This implementation returns <STRONG>ERR</STRONG>
        if the window pointer is null, or if the lower-level <STRONG>wget_wch</STRONG> call  re-
-       turns  an ERR.  In the latter case, an ERR return without other data is
+       turns  an <STRONG>ERR</STRONG>.  In the latter case, an <STRONG>ERR</STRONG> return without other data is
        treated as an end-of-file condition, and the returned array contains  a
        <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>.
 
        <STRONG>wchar_t</STRONG>  is  a  unsigned type.  All of the vendors implement this using
        <STRONG>wint_t</STRONG>, following the standard.
 
+       X/Open Curses issue 7 is unclear regarding whether the terminating <EM>null</EM>
+       <STRONG>wchar_t</STRONG>  value is counted in the length parameter <EM>n</EM>.  X/Open Curses is-
+       sue 7 revised the corresponding description of <STRONG>wgetnstr</STRONG> to address this
+       issue.   The unrevised description of <STRONG>wget_nwstr</STRONG> can be interpreted ei-
+       ther way.  This implementation counts the terminator in the length.
+
+       X/Open Curses does not specify what happens if the length  <EM>n</EM>  is  nega-
+       tive.
+
+       <STRONG>o</STRONG>   For  analogy  with  <STRONG>wgetnstr</STRONG>,  ncurses  6.2  uses a limit (based on
+           <STRONG>LINE_MAX</STRONG>).
+
+       <STRONG>o</STRONG>   Some other implementations (such as Solaris xcurses) do  the  same,
+           while others (PDCurses) do not allow this.
+
+       <STRONG>o</STRONG>   NetBSD  7 curses imitates ncurses 6.1 in this regard, treating a <STRONG>-1</STRONG>
+           as an indefinite number of characters.
+
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
        Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>.