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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 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.57 2024/06/08 20:47:39 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 2024-06-08 ncurses 6.5 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_instr 3x 2024-06-08 ncurses 6.5 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>                   Library calls                  <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><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>mvwinstr</STRONG>, <STRONG>mvwinnstr</STRONG>
  51        - get a string from a <EM>curses</EM> window
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>mvwinstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>);</STRONG>
  61
  62        <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
  63        <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
  64        <STRONG>int</STRONG> <STRONG>mvinnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
  65        <STRONG>int</STRONG> <STRONG>mvwinnstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
  66
  67
  68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        <STRONG>winstr</STRONG> extracts a string from a <EM>curses</EM>  window  <EM>win</EM>,  starting  at  the
  70        cursor  and  stopping  at  the  end  of the line, and stores it in <EM>str</EM>,
  71        terminating it with a null character and omitting  any  attributes  and
  72        color  pair  identifier  that  <EM>curses</EM>  associates  with each character.
  73        <STRONG>winnstr</STRONG> does the same, but copies at most <EM>n</EM> characters from <EM>win</EM>.  An  <EM>n</EM>
  74        of  <STRONG>-1</STRONG>  implies  no limit; <STRONG>winnstr</STRONG> then works like <STRONG>winstr</STRONG>.  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>
  75        describes the variants of these functions.
  76
  77
  78 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  79        These functions return the count of characters copied from <EM>win</EM> to  <EM>str</EM>,
  80        or <STRONG>ERR</STRONG> upon failure.
  81
  82        In <EM>ncurses</EM>, they return <STRONG>ERR</STRONG> if
  83
  84        <STRONG>o</STRONG>   <EM>win</EM> is <STRONG>NULL</STRONG> or
  85
  86        <STRONG>o</STRONG>   <EM>str</EM> is <STRONG>NULL</STRONG>.
  87
  88        Functions  prefixed with "mv" first perform cursor movement and fail if
  89        the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
  90
  91
  92 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  93        All of these functions except <STRONG>winnstr</STRONG> may be implemented as macros.
  94
  95        Reading a line that overflows the array pointed to by <EM>str</EM>  with  <STRONG>instr</STRONG>,
  96        <STRONG>winstr</STRONG>,  <STRONG>mvinstr</STRONG>, or <STRONG>mvwinstr</STRONG> causes undefined results.  Use of <STRONG>innstr</STRONG>,
  97        <STRONG>winnstr</STRONG>, <STRONG>mvinnstr</STRONG>, and <STRONG>mvwinnstr</STRONG> is recommended instead.
  98
  99
 100 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
 101        <STRONG>innstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinnstr</STRONG>, and <STRONG>mvwinnstr</STRONG>'s treatment of <STRONG>-1</STRONG> as  a  valid
 102        value of <EM>n</EM> is an <EM>ncurses</EM> extension.
 103
 104
 105 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 106        Applications employing <EM>ncurses</EM> extensions should condition their use on
 107        the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
 108
 109        X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
 110        error conditions for them.
 111
 112        X/Open  Curses  Issues  4 and 7 both state that <STRONG>instr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>mvinstr</STRONG>,
 113        and <STRONG>mvwinstr</STRONG> return <STRONG>OK</STRONG> rather than a character count.  This  is  likely
 114        an erratum.
 115
 116        <STRONG>o</STRONG>   SVr3.1  and  SVr4  implemented  <STRONG>winstr</STRONG> as a wrapper around <STRONG>winnstr</STRONG>,
 117            returning the latter's return value.  X/Open Curses's specification
 118            thus  may  have  been  an editorial solecism copied from System V's
 119            documentation (see below) by X/Open,  rather  than  an  intentional
 120            change.
 121
 122        <STRONG>o</STRONG>   <EM>ncurses</EM> retains compatibility with System V <EM>curses</EM> behavior.
 123
 124        SVr4  documents no return values apart from <STRONG>OK</STRONG> and <STRONG>ERR</STRONG> for any of these
 125        functions.  SVr4 does not document whether <EM>n</EM> counts the null terminator
 126        that these functions write to <EM>str</EM>.
 127
 128
 129 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
 130        SVr3.1 (1987) introduced these functions.
 131
 132
 133 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 134        <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>  describes  comparable functions of the <EM>ncurses</EM> library
 135        in its wide-character configuration (<EM>ncursesw</EM>).
 136
 137        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>, <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
 138
 139
 140
 141 ncurses 6.5                       2024-06-08                    <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
 142 </PRE>
 143 <div class="nav">
 144 <ul>
 145 <li><a href="#h2-NAME">NAME</a></li>
 146 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 147 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 148 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 149 <li><a href="#h2-NOTES">NOTES</a></li>
 150 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
 151 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 152 <li><a href="#h2-HISTORY">HISTORY</a></li>
 153 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 154 </ul>
 155 </div>
 156 </BODY>
 157 </HTML>