This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

curs_insstr(3X)                                                curs_insstr(3X)



NAME
       insstr,  insnstr,  winsstr,  winsnstr,  mvinsstr, mvinsnstr, mvwinsstr,
       mvwinsnstr - insert string before cursor in a curses window

SYNOPSIS
       #include <curses.h>
       int insstr(const char *str);
       int insnstr(const char *str, int n);
       int winsstr(WINDOW *win, const char *str);
       int winsnstr(WINDOW *win, const char *str, int n);
       int mvinsstr(int y, int x, const char *str);
       int mvinsnstr(int y, int x, const char *str, int n);
       int mvwinsstr(WINDOW *win, int y, int x, const char *str);
       int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);

DESCRIPTION
       These routines insert a character string (as many  characters  as  will
       fit on the line) before the character under the cursor.  All characters
       to the right of the cursor are shifted right with  the  possibility  of
       the  rightmost  characters on the line being lost.  The cursor position
       does not change (after moving to y, x, if  specified).   The  functions
       with  n  as  the  last argument insert a leading substring of at most n
       characters.  If n<=0, then the entire string is inserted.

       Special characters are handled as in addch.

RETURN VALUE
       All routines that return an integer return  ERR  upon  failure  and  OK
       (SVr4 specifies only "an integer value other than ERR") upon successful
       completion, unless otherwise noted in the  preceding  routine  descrip-
       tions.

       X/Open  defines  no  error  conditions.  In this implementation, if the
       window parameter is null or the str parameter  is  null,  an  error  is
       returned.

NOTES
       Note that all but winsnstr may be macros.

PORTABILITY
       These  functions  are  described  in  the XSI Curses standard, Issue 4,
       which adds const qualifiers to the arguments.

       The Single Unix Specification, Version 2 states that insnstr  and  win-snstr winsnstr
       snstr perform wrapping.  This is probably an error, since it makes this
       group of functions inconsistent.  Also,  no  implementation  of  curses
       documents this inconsistency.

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



                                                               curs_insstr(3X)