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

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 1998-2006,2010 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.16 2010/12/04 18:38:55 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 http://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>
  49 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>instr</STRONG>,  <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwin-</STRONG>
  51        <STRONG>str</STRONG>, <STRONG>mvwinnstr</STRONG> - get a string of characters from a  <STRONG>curses</STRONG>
  52        window
  53
  54
  55 </PRE>
  56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  58
  59        <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*str);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
  62        <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
  63        <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
  64        <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>
  65        <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>
  66        <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>
  67        <STRONG>n);</STRONG>
  68
  69
  70 </PRE>
  71 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  72        These routines return  a  string  of  characters  in  <EM>str</EM>,
  73        extracted  starting  at the current cursor position in the
  74        named window.  Attributes are stripped  from  the  charac-
  75        ters.   The  four  functions  with  <EM>n</EM> as the last argument
  76        return a leading  substring  at  most  <EM>n</EM>  characters  long
  77        (exclusive of the trailing NUL).
  78
  79
  80 </PRE>
  81 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  82        All  of the functions return <STRONG>ERR</STRONG> upon failure, or the num-
  83        ber of characters actually read into the string.
  84
  85        X/Open defines no error conditions.  In  this  implementa-
  86        tion, if the window parameter is null or the str parameter
  87        is null, a zero is returned.
  88
  89        Functions with a "mv" prefix first perform a cursor  move-
  90        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
  91        outside the window, or if the window pointer is null.
  92
  93
  94 </PRE>
  95 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  96        Note that all routines except <STRONG>winnstr</STRONG> may be macros.
  97
  98
  99 </PRE>
 100 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 101        SVr4 does not document whether a length limit includes  or
 102        excludes the trailing NUL.
 103
 104        The  ncurses library extends the XSI description by allow-
 105        ing a negative value for <EM>n</EM>.  In this case,  the  functions
 106        return the string ending at the right margin.
 107
 108
 109 </PRE>
 110 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 111        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 112
 113
 114
 115                                                          <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
 116 </PRE>
 117 <div class="nav">
 118 <ul>
 119 <li><a href="#h2-NAME">NAME</a></li>
 120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 123 <li><a href="#h2-NOTES">NOTES</a></li>
 124 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 125 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 126 </ul>
 127 </div>
 128 </BODY>
 129 </HTML>