Query: getn_wstr
OS: opensolaris
Section: 3xcurses
Links: opensolaris man pages all man pages
Forums: forum home forum categories
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
getn_wstr(3XCURSES) X/Open Curses Library Functions getn_wstr(3XCURSES)NAMEgetn_wstr, get_wstr, mvgetn_wstr, mvget_wstr, mvwgetn_wstr, mvwget_wstr, wgetn_wstr, wget_wstr - get a wide character string from terminalSYNOPSIScc [ 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 getn_wstr(wint_t *wstr, int n); int get_wstr(wint_t *wstr); int mvgetn_wstr(int y, int x, wint_t *wstr, int n); int mvget_wstr(int y, int x, wint_t *wstr); int mvwgetn_wstr(WINDOW *win, int y, int x, wint_t *wstr, int n); int mvwget_wstr(WINDOW *win, int y, int x, wint_t *wstr); int wgetn_wstr(WINDOW *win, wint_t *wstr, int n); int wget_wstr(WINDOW *win, wint_t *wstr);DESCRIPTIONThe get_wstr() and wget_wstr() functions get a wide character string from the terminal associated with the window stdscr or window win, respectively. The mvget_str() and mvwget_wstr() functions move the cursor to the position specified in stdscr or win, respectively, then get a wide character string. These functions call wget_wch(3XCURSES) and place each received character in wstr until a newline character, end-of-line character, or end-of-file character is received, which is also placed in wstr. The erase and kill characters set by the user are processed. The getn_wstr(), mvgetn_wstr(), mvwgetn_wstr() and wgetn_wstr() functions read at most n characters. These functions are used to prevent overflowing the input buffer.PARAMETERSwstr Is a pointer to the area where the character string is to be placed. n Is the maximum number of characters to read from input. y Is the y (row) coordinate of starting position of character string to be read. x Is the x (column) coordinate of starting position of character string to be read. win points to the window associated with the terminal from which the character is to be read.RETURN VALUESOn success, these functions return OK. Otherwise, they return ERR.ERRORSNone.ATTRIBUTESSee attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |Unsafe | +-----------------------------+-----------------------------+SEE ALSOget_wch(3XCURSES), getnstr(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5) SunOS 5.11 5 Jun 2002 getn_wstr(3XCURSES)