Index for Section 3

Alphabetical listing for C

Bottom of page

curs_insstr(3)
NAME
  curs_insstr, insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr,
  mvwinsstr, mvwinsnstr - Insert a string before the character under the
  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 );

LIBRARY
  Curses Library (libcurses)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, mvwinsstr,
  mvwinsnstr:  XCURSES4.2

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

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 moved to the 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). 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 routines insert the entire string.

  If a character in str is a tab, newline, carriage return, or backspace, the
  routines move the cursor appropriately within the window. A newline also
  causes 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.

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

  Note that all but winsnstr may be macros.

RETURN VALUES
  All routines return the integer ERR upon failure and OK upon successful
  completion.

SEE ALSO
  Functions: curses(3), curs_clear(3), curs_inch(3)

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page