opensolaris man page for win_wch

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

NAME
       in_wch, mvin_wch, mvwin_wch, win_wch - retrieve a complex character (with 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 in_wch(cchar_t *wcval);

       int mvin_wch(int y, int x, cchar_t *wcval);

       int mvwin_wch(WINDOW *win, inty, cchar_t *wcval);

       int win_wch(WINDOW *win, cchar_t *wcval);

DESCRIPTION
       The in_wch() and win_wch() functions retrieve the complex character and its rendition located at the current cursor position of the  stdscr
       window and window win, respectively. The mvin_wch() and mvwin_wch() functions retrieve the complex character and its rendition  located	at
       the position indicated by the x	(column) and y (row) parameters (the former in the stdscr window; the latter in window win).

       All these functions store the retrieved character and its rendition in the  object pointed to by wcval.

PARAMETERS
       wcval	Is a pointer to an object that can store a complex character and its rendition.

       y	Is the y (row) coordinate of the position of the character to be returned.

       x	Is the x (column) coordinate of the position of the character to be returned.

       win	Is a pointer to the window that contains the character to be returned.

RETURN VALUES
       On success, these functions return OK. Otherwise, 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
       add_wch(3XCURSES), inch(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)

SunOS 5.11							    5 Jun 2002							  in_wch(3XCURSES)