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

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>instr</B>,  <B>innstr</B>, <B>winstr</B>, <B>winnstr</B>, <B>mvinstr</B>, <B>mvinnstr</B>, <B>mvwin-</B>
   9        <B>str</B>, <B>mvwinnstr</B> - get a string of characters from a  <B>curses</B>
  10        window
  11
  12
  13 </PRE>
  14 <H2>SYNOPSIS</H2><PRE>
  15        <B>#include</B> <B>&lt;curses.h&gt;</B>
  16
  17        <B>int</B> <B>instr(char</B> <B>*str);</B>
  18        <B>int</B> <B>innstr(char</B> <B>*str,</B> <B>int</B> <B>n);</B>
  19        <B>int</B> <B>winstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str);</B>
  20        <B>int</B> <B>winnstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
  21        <B>int</B> <B>mvinstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B>
  22        <B>int</B> <B>mvinnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
  23        <B>int</B> <B>mvwinstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B>
  24        <B>int</B>  <B>mvwinnstr(WINDOW</B>  <B>*win,</B>  <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B>
  25        <B>n);</B>
  26
  27
  28 </PRE>
  29 <H2>DESCRIPTION</H2><PRE>
  30        These routines return  a  string  of  characters  in  <I>str</I>,
  31        extracted  starting  at the current cursor position in the
  32        named window.  Attributes are stripped  from  the  charac-
  33        ters.   The  four  functions  with  <I>n</I> as the last argument
  34        return a leading  substring  at  most  <I>n</I>  characters  long
  35        (exclusive of the trailing NUL).
  36
  37
  38 </PRE>
  39 <H2>RETURN VALUE</H2><PRE>
  40        All  of the functions return <B>ERR</B> upon failure, or the num-
  41        ber of characters actually read into the string.
  42
  43
  44 </PRE>
  45 <H2>NOTES</H2><PRE>
  46        Note that all routines except <B>winnstr</B> may be macros.
  47
  48
  49 </PRE>
  50 <H2>PORTABILITY</H2><PRE>
  51        The XSI Curses error  conditions  <B>EILSEQ</B>  and  <B>EILOVERFLOW</B>
  52        associated  with  extended-level  conformance  are not yet
  53        detected (this implementation does not  yet  support  XPG4
  54        multi-byte  characters).  SVr4 does not document whether a
  55        length limit includes or excludes the trailing NUL.
  56
  57        The ncurses library extends the XSI description by  allow-
  58        ing  a  negative value for <I>n</I>.  In this case, the functions
  59        return the string ending at the right margin.
  60
  61
  62 </PRE>
  63 <H2>SEE ALSO</H2><PRE>
  64        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>.
  65
  66
  67
  68
  69
  70
  71
  72
  73 </PRE>
  74 <HR>
  75 <ADDRESS>
  76 Man(1) output converted with
  77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  78 </ADDRESS>
  79 </BODY>
  80 </HTML>