Index for Section 3

Alphabetical listing for C

Bottom of page

curs_in_wchstr(3)
NAME
  curs_in_wchstr, in_wchstr, in_wchnstr, win_wchstr, win_wchnstr,
  mvin_wchstr, mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - Input an array of
  complex characters and renditions from a Curses window

SYNOPSIS
  #include <curses.h>

  int in_wchstr(
	  cchar_t *wchstr );

  int in_wchnstr(
	  cchar_t *wchstr,
	  int n );

  int win_wchstr(
	  WINDOW *win,
	  cchar_t *wchstr );

  int win_wchnstr(
	  WINDOW *win,
	  cchar_t *wchstr,
	  int n );

  int mvin_wchstr(
	  int y,
	  int x,
	  cchar_t *wchstr );

  int mvin_wchnstr(
	  int y,
	  int x,
	  cchar_t *wchstr,
	  int n );

  int mvwin_wchstr(
	  WINDOW *win,
	  int y,
	  int x,
	  cchar_t *wchstr );

  int mvwin_wchnstr(
	  WINDOW *win,
	  int y,
	  int x,
	  cchar_t *wchstr,
	  int n );

LIBRARY
  Curses Library (libcurses)

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

  in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, vin_wchstr, mvin_wchnstr,
  mvwin_wchstr, mvwin_wchnstr:	XCURSES4.2

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

DESCRIPTION
  These functions extract characters from the current or specified window,
  starting at the current or specified position and ending at the end of the
  line, and place them in the array pointed to by wchstr.

  The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the array
  with at most n cchar_t elements.

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

  Note that all routines except win_wchnstr may be macros.

  Reading a line that overflows the array pointed to by wchstr with
  in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined
  results. Therefore, the use of in_wchnstr, mvin_wchnstr, mvwin_wchnstr, or
  win_wchnstr is recommended.

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

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

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page