+<!--
+ ****************************************************************************
+ * Copyright 2018,2020 Thomas E. Dickey *
+ * Copyright 1998-2010,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 *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: curs_inchstr.3x,v 1.21 2020/10/18 00:24:36 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 https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_inchstr 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">curs_inchstr 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="curs_inchstr.3X.html">curs_inchstr(3X)</A></B> <B><A HREF="curs_inchstr.3X.html">curs_inchstr(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>inchstr</B>, <B>inchnstr</B>, <B>winchstr</B>, <B>winchnstr</B>, <B>mvinchstr</B>,
- <B>mvinchnstr</B>, <B>mvwinchstr</B>, <B>mvwinchnstr</B> - get a string of
- characters (and attributes) from a <B>curses</B> window
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>inchstr</B>, <B>inchnstr</B>, <B>winchstr</B>, <B>winchnstr</B>, <B>mvinchstr</B>, <B>mvinchnstr</B>,
+ <B>mvwinchstr</B>, <B>mvwinchnstr</B> - get a string of characters (and attributes)
+ from a <B>curses</B> window
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<B>#include</B> <B><curses.h></B>
- <B>int</B> <B>inchstr(chtype</B> <B>*chstr);</B>
- <B>int</B> <B>inchnstr(chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
- <B>int</B> <B>winchstr(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>*chstr);</B>
- <B>int</B> <B>winchnstr(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
- <B>int</B> <B>mvinchstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr);</B>
- <B>int</B> <B>mvinchnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
- <B>int</B> <B>mvwinchstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr);</B>
- <B>int</B> <B>mvwinchnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr,</B>
- <B>int</B> <B>n);</B>
+ <B>int</B> <B>inchstr(chtype</B> <B>*</B><I>chstr</I><B>);</B>
+ <B>int</B> <B>inchnstr(chtype</B> <B>*</B><I>chstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+ <B>int</B> <B>winchstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>chtype</B> <B>*</B><I>chstr</I><B>);</B>
+ <B>int</B> <B>winchnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>chtype</B> <B>*</B><I>chstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+ <B>int</B> <B>mvinchstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <B>*</B><I>chstr</I><B>);</B>
+ <B>int</B> <B>mvinchnstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <B>*</B><I>chstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+ <B>int</B> <B>mvwinchstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <B>*</B><I>chstr</I><B>);</B>
+ <B>int</B> <B>mvwinchnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <B>*</B><I>chstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- These routines return a NULL-terminated array of <B>chtype</B>
- quantities, starting at the current cursor position in the
- named window and ending at the right margin of the window.
- The four functions with <I>n</I> as the last argument, return a
- leading substring at most <I>n</I> characters long (exclusive of
- the trailing (chtype)0). Constants defined in <B><curses.h></B>
- can be used with the <B>&</B> (logical AND) operator to extract
- the character or the attribute alone from any position in
- the <I>chstr</I> [see <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>].
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ These routines return a NULL-terminated array of <B>chtype</B> quantities,
+ starting at the current cursor position in the named window and ending
+ at the right margin of the window. The four functions with <I>n</I> as the
+ last argument, return a leading substring at most <I>n</I> characters long
+ (exclusive of the trailing (chtype)0). Constants defined in <B><curses.h></B>
+ can be used with the <B>&</B> (logical AND) operator to extract the character
+ or the attribute alone from any position in the <I>chstr</I> [see
+ <B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>].
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- All routines return the integer <B>ERR</B> upon failure and an
- integer value other than <B>ERR</B> upon successful completion
- (the number of characters retrieved, exclusive of the
- trailing 0).
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ All routines return the integer <B>ERR</B> upon failure and an integer value
+ other than <B>ERR</B> upon successful completion (the number of characters re-
+ trieved, exclusive of the trailing 0).
-</PRE>
-<H2>NOTES</H2><PRE>
- Note that all routines except <B>winchnstr</B> may be macros.
- SVr4 does not document whether the result string is 0-ter-
- minated; it does not document whether a length limit argu-
- ment includes any trailing 0; and it does not document the
- meaning of the return value.
+ X/Open Curses defines no error conditions. In this implementation:
+ <B>o</B> If the <I>win</I> parameter is null, an error is returned,
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- These functions are described in the XSI Curses standard,
- Issue 4. It is no more specific than the SVr4 documenta-
- tion on the trailing 0. It does specify that the success-
- ful return of the functions is <B>OK</B>.
+ <B>o</B> If the <I>chstr</I> parameter is null, an error is returned,
+ Functions with a "mv" prefix first perform a cursor movement using
+ <B>wmove</B>, and return an error if the position is outside the window, or if
+ the window pointer is null.
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>.
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ Note that all routines except <B>winchnstr</B> may be macros. SVr4 does not
+ document whether the result string is zero-terminated; it does not doc-
+ ument whether a length limit argument includes any trailing 0; and it
+ does not document the meaning of the return value.
+
+
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These functions are described in the XSI Curses standard, Issue 4. It
+ is no more specific than the SVr4 documentation on the trailing 0. It
+ does specify that the successful return of the functions is <B>OK</B>.
+
+
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>.
+
+ Comparable functions in the wide-character (ncursesw) library are de-
+ scribed in <B><A HREF="curs_in_wchstr.3X.html">curs_in_wchstr(3X)</A></B>.
+ <B><A HREF="curs_inchstr.3X.html">curs_inchstr(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff