winwstr(3xcurses) [sunos man page]

innwstr(3XCURSES)					  X/Open Curses Library Functions					 innwstr(3XCURSES)

NAME

       innwstr, inwstr, mvinnwstr, mvinwstr, mvwinnwstr, mvwinwstr, winnwstr, winwstr - retrieve a wide character string (without rendition)

SYNOPSIS

       cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib 
       -R /usr/xpg4/lib -lcurses [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <curses.h>

       int innwstr(wchar_t *wstr, int n);

       int inwstr(wchar_t *wstr);

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

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

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

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

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

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

PARAMETERS

       wstr	Is a pointer to an object that can hold the retrieved multibyte character string.

       n	Is the number of characters not to exceed when retrieving wstr.

       y	Is the y (row) coordinate of the starting position of the string to be	retrieved.

       x	Is the x (column) coordinate of the starting position of the string to	be retrieved.

       win	Is a pointer to the window in which the string is to be retrieved.

DESCRIPTION

       The  inwstr() and winwstr() functions retrieve a wide character string (without attributes) starting at the current cursor position  of the
       stdscr window and window win, respectively, and ending at the right margin. The mvinwstr() and mvwinwstr() functions retrieve a wide  char-
       acter  string  located at the position indicated by the x (column) and  y (row) parameters (the former in the stdscr window; the latter	in
       window win).

       The innwstr(), winnwstr(), mvinnwstr(), and  mvwinnwstr() functions retrieve at most n characters from the  window stdscr and win,  respec-
       tively.	 The  former two functions retrieve the string starting at the current cursor position; the latter two commands return the string,
       starting at the position  specified by the x and y parameters.

       All these functions store the retrieved string in the object pointed to by wstr. They only store complete  wide	characters.  If  the  area
       pointed to by wstr is not large enough to hold at least one character, these functions fail.

       Only  the  character  portion  of  the character/rendition pair is returned.  To return the complete character/rendition pair, use win_wch-
       str(3XCURSES).

RETURN VALUES

       On success, the inwstr(), mvinwstr(), mvwinwstr(), and winwstr() functions return OK. Otherwise, they return ERR.

       On success, the innwstr(), mvinnwstr(), mvwinnwstr(), and winnwstr() functions return the number of characters read into the string. Other-
       wise, they return ERR.

ERRORS

       None.

ATTRIBUTES

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       in_wch(3XCURSES), in_wchnstr(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)

SunOS 5.10							    5 Jun 2002							 innwstr(3XCURSES)

innwstr(3XCURSES)					  X/Open Curses Library Functions					 innwstr(3XCURSES)

NAME

       innwstr, inwstr, mvinnwstr, mvinwstr, mvwinnwstr, mvwinwstr, winnwstr, winwstr - retrieve a wide character string (without rendition)

SYNOPSIS

       cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib 
       -R /usr/xpg4/lib -lcurses [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <curses.h>

       int innwstr(wchar_t *wstr, int n);

       int inwstr(wchar_t *wstr);

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

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

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

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

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

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

PARAMETERS

       wstr	Is a pointer to an object that can hold the retrieved multibyte character string.

       n	Is the number of characters not to exceed when retrieving wstr.

       y	Is the y (row) coordinate of the starting position of the string to be	retrieved.

       x	Is the x (column) coordinate of the starting position of the string to	be retrieved.

       win	Is a pointer to the window in which the string is to be retrieved.

DESCRIPTION

       The  inwstr() and winwstr() functions retrieve a wide character string (without attributes) starting at the current cursor position  of the
       stdscr window and window win, respectively, and ending at the right margin. The mvinwstr() and mvwinwstr() functions retrieve a wide  char-
       acter  string  located at the position indicated by the x (column) and  y (row) parameters (the former in the stdscr window; the latter	in
       window win).

       The innwstr(), winnwstr(), mvinnwstr(), and  mvwinnwstr() functions retrieve at most n characters from the  window stdscr and win,  respec-
       tively.	 The  former two functions retrieve the string starting at the current cursor position; the latter two commands return the string,
       starting at the position  specified by the x and y parameters.

       All these functions store the retrieved string in the object pointed to by wstr. They only store complete  wide	characters.  If  the  area
       pointed to by wstr is not large enough to hold at least one character, these functions fail.

       Only  the  character  portion  of  the character/rendition pair is returned.  To return the complete character/rendition pair, use win_wch-
       str(3XCURSES).

RETURN VALUES

       On success, the inwstr(), mvinwstr(), mvwinwstr(), and winwstr() functions return OK. Otherwise, they return ERR.

       On success, the innwstr(), mvinnwstr(), mvwinnwstr(), and winnwstr() functions return the number of characters read into the string. Other-
       wise, they return ERR.

ERRORS

       None.

ATTRIBUTES

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       in_wch(3XCURSES), in_wchnstr(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)

SunOS 5.10							    5 Jun 2002							 innwstr(3XCURSES)