Index for Section 3

Alphabetical listing for C

Bottom of page

curs_ins_wstr(3)
NAME
  curs_ins_wstr, ins_wstr, ins_nwstr, wins_wstr, wins_nwstr, mvins_wstr,
  mvins_nwstr, mvwins_wstr, mvwins_nwstr - Insert a wide-character string
  into a Curses window

SYNOPSIS
  #include <curses.h>

  int ins_wstr(
	  const wchar_t *wstr );

  int ins_nwstr(
	  const wchar_t *wstr,
	  int n );

  int wins_wstr(
	  WINDOW *win,
	  const wchar_t *wstr );

  int wins_nwstr(
	  WINDOW *win,
	  const wchar_t *wstr,
	  int n );

  int mvins_wstr(
	  int y,
	  int x,
	  const wchar_t *wstr );

  int mvins_nwstr(
	  int y,
	  int x,
	  const wchar_t *wstr,
	  int n );

  int mvwins_wstr(
	  WINDOW *win,
	  int y,
	  int x,
	  const wchar_t *wstr );

  int mvwins_nwstr(
	  WINDOW *win,
	  int y,
	  int x,
	  const wchar_t *wstr,
	  int n );

LIBRARY
  Curses Library (libcurses)

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

  ins_wstr, ins_nwstr, wins_wstr, wins_nwstr, mvins_wstr, mvins_nwstr,
  mvwins_wstr, mvwins_nwstr:  XCURSES4.2

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

DESCRIPTION
  These functions insert a wchar_t character string (as many wchar_t
  characters as will fit on the line) in the current or specified window
  immediately before the current or specified position. 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.

  Any nonspacing characters in the string are associated with the first
  spacing character in the string that precedes the nonspacing characters. If
  the first character in the string is a nonspacing character, these
  functions will fail.

  These functions:

    ·  Do not perform wrapping

    ·  Do not advance the cursor position

    ·  Perform special-character processing

  If a character in wstr is a tab, newline, carriage return, or backspace,
  the cursor is moved appropriately within the window. A newline also results
  in clrtoeol before the cursor is moved. Tabs are considered to be at every
  eighth column. If a character in wstr is another control character, it is
  drawn in the ^X notation. Calling win_wch 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.

  The ins_nwstr, mvins_nwstr, mvwins_nwstr, and wins_nwstr functions insert
  at most n wchar_t characters.	 If n is less than 1, then these functions
  insert the entire string.

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

  Note that all but wins_nwstr may be macros.

RETURN VALUES
  Upon successful completion, these functions return OK.  Otherwise, they
  return ERR.

SEE ALSO
  Functions: curses(3), curs_in_wch(3), curs_ins_wch(3)

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page