doc/html/man/curs_instr.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018,2020 Thomas E. Dickey                                     *
   4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_instr.3x,v 1.22 2020/10/18 00:18:27 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_instr 3X</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_instr 3X</H1>
  43 <PRE>
  44 <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>                                                  <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <B>instr</B>,  <B>innstr</B>, <B>winstr</B>, <B>winnstr</B>, <B>mvinstr</B>, <B>mvinnstr</B>, <B>mvwinstr</B>, <B>mvwinnstr</B>
  51        - get a string of characters from a <B>curses</B> window
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <B>#include</B> <B>&lt;curses.h&gt;</B>
  56
  57        <B>int</B> <B>instr(char</B> <B>*</B><I>str</I><B>);</B>
  58        <B>int</B> <B>innstr(char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  59        <B>int</B> <B>winstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
  60        <B>int</B> <B>winnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  61
  62        <B>int</B> <B>mvinstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
  63        <B>int</B> <B>mvinnstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  64        <B>int</B> <B>mvwinstr(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>char</B> <B>*</B><I>str</I><B>);</B>
  65        <B>int</B> <B>mvwinnstr(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>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
  66
  67
  68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        These routines return a string of characters in <I>str</I>, extracted starting
  70        at  the  current  cursor  position in the named window.  Attributes are
  71        stripped from the characters.  The four functions with <I>n</I>  as  the  last
  72        argument   return  a  leading  substring  at  most  <I>n</I>  characters  long
  73        (exclusive of the trailing NUL).
  74
  75
  76 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  77        All of the  functions  return  <B>ERR</B>  upon  failure,  or  the  number  of
  78        characters actually read into the string.
  79
  80        X/Open Curses defines no error conditions.  In this implementation:
  81
  82        <B>o</B>   If the <I>win</I> parameter is null, an error is returned,
  83
  84        <B>o</B>   If the <I>chstr</I> parameter is null, an error is returned,
  85
  86        Functions  with  a  "mv"  prefix  first perform a cursor movement using
  87        <B>wmove</B>, and return an error if the position is outside the window, or if
  88        the window pointer is null.
  89
  90
  91 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  92        Note that all routines except <B>winnstr</B> may be macros.
  93
  94
  95 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  96        SVr4  does not document whether a length limit includes or excludes the
  97        trailing NUL.
  98
  99        The ncurses library extends the XSI description by allowing a  negative
 100        value  for  <I>n</I>.  In this case, the functions return the string ending at
 101        the right margin.
 102
 103
 104 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 105        <B><A HREF="curses.3X.html">curses(3X)</A></B>.
 106
 107
 108
 109                                                                 <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>
 110 </PRE>
 111 <div class="nav">
 112 <ul>
 113 <li><a href="#h2-NAME">NAME</a></li>
 114 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 115 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 116 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 117 <li><a href="#h2-NOTES">NOTES</a></li>
 118 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 120 </ul>
 121 </div>
 122 </BODY>
 123 </HTML>