opensolaris man page for winwstr

curs_inwstr(3CURSES)					     Curses Library Functions					      curs_inwstr(3CURSES)

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

SYNOPSIS
       cc [ flag ... ] file ... -lcurses[library .. ]
       #include <curses.h>

       int inwstr(wchar_t *wstr);

       int innwstr(wchar_t *wstr, int n);

       int winwstr(WINDOW *win, wchar_t *wstr);

       int winnwstr(WINDOW *win, wchar_t *wstr, int n);

       int mvinwstr(int y, int x, wchar_t *wstr);

       int mvinnwstr(int y, int x, wchar_t *wstr, int n);

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

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

DESCRIPTION
       These routines return the string of  wchar_t characters in  wstr starting at the current cursor position in the named window and ending	at
       the  right  margin  of  the window. Attributes are stripped from the characters. The four functions with  n as the last argument return the
       string at most n wchar_t characters long.

RETURN VALUES
       All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       curses(3CURSES), attributes(5)

NOTES
       The header file <curses.h> automatically includes the header files <stdio.h>, <unctrl.h> and <widec.h>.

       Note that all routines except  winnwstr() may be macros.

SunOS 5.11							    31 Dec 1996 					      curs_inwstr(3CURSES)