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

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