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)
Check Out this Related Man Page
in_wchnstr(3XCURSES) X/Open Curses Library Functions in_wchnstr(3XCURSES)NAME
in_wchnstr, in_wchstr, mvin_wchnstr, mvin_wchstr, mvwin_wchnstr, mvwin_wchstr, win_wchnstr, win_wchstr - retrieve complex character string
(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_wchnstr(cchar_t *wchstr, int n);
int in_wchstr(cchar_t *wchstr);
int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
int mvin_wchstr(int y, int x, cchar_t *wchstr);
int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);
int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
int win_wchstr(WINDOW *win, cchar_t *wchstr);
DESCRIPTION
The in_wchstr() and win_wchstr() functions retrieve a complex character string (with rendition) starting at the current cursor position of
the stdscr window and window win, respectively, and ending at the right margin. The mvin_wchstr() and mvwin_wchstr() functions retrieve a
complex character 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 in_wchnstr(), win_wchnstr(), mvin_wchnstr(), and mvwin_wchnstr() functions retrieve at most n characters from the window stdscr and
win, respectively.
The former two functions retrieve the string, starting at the current cursor position; the latter two commands retrieve the string,
starting at the position specified by the x and y parameters.
The retrieved character string (with renditions) is stored in the object pointed to by wcval.
PARAMETERS
wchstr Is a pointer to an object where the retrieved complex character string can be stored.
n Is the number of characters not to exceed when retrieving wchstr.
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.
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 in_wch(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)SunOS 5.10 5 Jun 2002 in_wchnstr(3XCURSES)