curs_insstr(3X)  MISCELLANEOUS LIBRARY FUNCTIONS  curs_insstr(3X)



NAME
     curs_instr:  insstr, insnstr, winsstr,  winsnstr,  mvinsstr,
     mvinsnstr,  mvwinsstr,  mvwinsnstr  -  insert  string before
     character under the cursor in a curses window

SYNOPSIS
     #include <curses.h>

     int insstr(char *str);
     int insnstr(char *str, int n);
     int winsstr(WINDOW *win, char *str);
     int winsnstr(WINDOW *win, char *str, int n);
     int mvinsstr(int y, int x, char *str);
     int mvinsnstr(int y, int x, char *str, int n);
     int mvwinsstr(WINDOW *win, int y, int x, char *str);
     int mvwinsnstr(WINDOW *win, int y, int x, char *str, int n);

DESCRIPTION
     With these routines, a character string (as many  characters
     as  will  fit  on the line) is inserted before the character
     under the cursor.  All characters to the right of the cursor
     are  moved  to the right, with the possibility of the right-
     most characters on the line being lost.  The cursor position
     does not change (after moving to y, x, if specified).  (This
     does  not  imply  use  of  the  hardware  insert   character
     feature.)   The  four  routines  with n as the last argument
     insert at most n  characters.   If  n<=0,  then  the  entire
     string  is  inserted.   If a character in str is a tab, new-
     line, carriage return or  backspace,  the  cursor  is  moved
     appropriately  within  the  window.   A  newline also does a
     clrtoeol before moving.  Tabs are considered to be at  every
     eighth  column.   If  a  character in str is another control
     character, it is drawn in the ^X  notation.   Calling  winch
     after  adding  a  control  character  (and  moving to it, if
     necessary)  does  not  return  the  control  character,  but
     instead returns the representation of the control character.

RETURN VALUE
     All routines return the integer  ERR  upon  failure  and  an
     integer value other than ERR upon successful completion.

NOTES
     The header file <curses.h> automatically includes the header
     files <stdio.h> and <unctrl.h>.

     Note that all but winsnstr may be macros.

SEE ALSO
     curses(3X), curs_clear(3X), curs_inch(3X).






                          Last change:                          1