doc/html/man/curs_insstr.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>insstr</B>,  <B>insnstr</B>,  <B>winsstr</B>, <B>winsnstr</B>, <B>mvinsstr</B>, <B>mvinsnstr</B>,
   9        <B>mvwinsstr</B>, <B>mvwinsnstr</B> - insert string before cursor  in  a
  10        <B>curses</B> window
  11
  12
  13 </PRE>
  14 <H2>SYNOPSIS</H2><PRE>
  15        <B>#include</B> <B>&lt;curses.h&gt;</B>
  16        <B>int</B> <B>insstr(const</B> <B>char</B> <B>*str);</B>
  17        <B>int</B> <B>insnstr(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
  18        <B>int</B> <B>winsstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str);</B>
  19        <B>int</B> <B>winsnstr(WINDOW</B> <B>*win,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
  20        <B>int</B> <B>mvinsstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B>
  21        <B>int</B> <B>mvinsnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
  22        <B>int</B> <B>mvwinsstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str);</B>
  23        <B>int</B> <B>mvwinsnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>const</B> <B>char</B> <B>*str,</B>
  24        <B>int</B> <B>n);</B>
  25
  26
  27 </PRE>
  28 <H2>DESCRIPTION</H2><PRE>
  29        These  routines insert a character string (as many charac-
  30        ters as will fit on the line) before the  character  under
  31        the cursor.  All characters to the right of the cursor are
  32        shifted right, with the possibility of the rightmost char-
  33        acters  on  the line being lost.  The cursor position does
  34        not change (after moving to <I>y</I>, <I>x</I>, if specified). The  four
  35        routines with <I>n</I> as the last argument insert a leading sub-
  36        string of at most <I>n</I> characters.  If <I>n</I>&lt;=0, then the  entire
  37        string is inserted.
  38
  39        If  a  character in <I>str</I> is a tab, newline, carriage return
  40        or backspace, the cursor is moved appropriately within the
  41        window.   A  newline  also  does a <B>clrtoeol</B> before moving.
  42        Tabs are considered to be at every eighth  column.   If  a
  43        character in <I>str</I> is another control character, it is drawn
  44        in the <B>^</B><I>X</I> notation.  Calling <B>winch</B> after adding a  control
  45        character (and moving to it, if necessary) does not return
  46        the control character, but instead returns a character  in
  47        the ^-representation of the control character.
  48
  49
  50 </PRE>
  51 <H2>RETURN VALUE</H2><PRE>
  52        All  routines that return an integer return <B>ERR</B> upon fail-
  53        ure and OK (SVr4 specifies only "an  integer  value  other
  54        than  <B>ERR</B>")  upon  successful completion, unless otherwise
  55        noted in the preceding routine descriptions.
  56
  57
  58 </PRE>
  59 <H2>NOTES</H2><PRE>
  60        Note that all but <B>winsnstr</B> may be macros.
  61
  62
  63 </PRE>
  64 <H2>PORTABILITY</H2><PRE>
  65        These functions are described in the XSI Curses  standard,
  66        Issue  4,  which  adds  const qualifiers to the arguments.
  67        The XSI Curses error  conditions  <B>EILSEQ</B>  and  <B>EILOVERFLOW</B>
  68        associated  with  extended-level  conformance  are not yet
  69        detected (this implementation does not  yet  support  XPG4
  70        multi-byte characters).
  71
  72
  73 </PRE>
  74 <H2>SEE ALSO</H2><PRE>
  75        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B>, <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>.
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128 </PRE>
 129 <HR>
 130 <ADDRESS>
 131 Man(1) output converted with
 132 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 133 </ADDRESS>
 134 </BODY>
 135 </HTML>