Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
curs_inwstr(3X)						       curs_inwstr(3X)

NAME
       inwstr,	innwstr,  winwstr,  winnwstr,  mvinwstr, mvinnwstr, mvwinwstr,
       mvwinnwstr - get	a string of wchar_t characters from a curses window

SYNOPSIS
       #include	<curses.h>

       int inwstr(wchar_t *str);
       int innwstr(wchar_t *str, int n);
       int winwstr(WINDOW *win,	wchar_t	*str);
       int winnwstr(WINDOW *win, wchar_t *str, int n);
       int mvinwstr(int	y, int x, wchar_t *str);
       int mvinnwstr(int y, int	x, wchar_t *str, int n);
       int mvwinwstr(WINDOW *win, int y, int x,	wchar_t	*str);
       int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *str, int n);

DESCRIPTION
       These routines return a string of wchar_t characters in wstr, extracted
       starting	  at   the  current  cursor  position  in  the	named  window.
       Attributes are stripped from the	characters.  The four functions	with n
       as  the	last  argument return a	leading	substring at most n bytes long
       (exclusive of the trailing NUL).	 Transfer stops	at the end of the cur-
       rent  line, or when n bytes have	been stored at the location referenced
       by wstr.

       If the size n is	not large enough to store  a  complete	character,  an
       error is	generated.

NOTES
       Note that all routines except winnwstr may be macros.

RETURN VALUES
       All  routines  return ERR upon failure. Upon successful completion, the
       *inwstr routines	return OK, and the *innwstr routines return the	number
       of characters read into the string.

SEE ALSO
       curses(3X), curs_instr(3X), curs_in_wchstr(3X)

							       curs_inwstr(3X)

NAME | SYNOPSIS | DESCRIPTION | NOTES | RETURN VALUES | SEE ALSO

Want to link to this manual page? Use this URL:
<http://www.freebsd.org/cgi/man.cgi?query=curs_inwstr&sektion=3x&manpath=FreeBSD+9.2-RELEASE>

home | help