suse man page for mvinchstr

Query: mvinchstr

OS: suse

Section: 3ncurses

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

inchstr(3NCURSES)														 inchstr(3NCURSES)

NAME
inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr, mvwinchstr, mvwinchnstr - get a string of characters (and attributes) from a curses window
SYNOPSIS
#include <curses.h> int inchstr(chtype *chstr); int inchnstr(chtype *chstr, int n); int winchstr(WINDOW *win, chtype *chstr); int winchnstr(WINDOW *win, chtype *chstr, int n); int mvinchstr(int y, int x, chtype *chstr); int mvinchnstr(int y, int x, chtype *chstr, int n); int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr); int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);
DESCRIPTION
These routines return a NULL-terminated array of chtype quantities, starting at the current cursor position in the named window and ending at the right margin of the window. The four functions with n as the last argument, return a leading substring at most n characters long (exclusive of the trailing (chtype)0). Constants defined in <curses.h> can be used with the & (logical AND) operator to extract the char- acter or the attribute alone from any position in the chstr [see inch(3NCURSES)].
RETURN VALUE
All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion (the number of characters retrieved, exclusive of the trailing 0). No error conditions are defined. If the chstr parameter is null, no data is returned, and the return value is zero.
NOTES
Note that all routines except winchnstr may be macros. SVr4 does not document whether the result string is 0-terminated; it does not docu- ment whether a length limit argument includes any trailing 0; and it does not document the meaning of the return value.
PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. It is no more specific than the SVr4 documentation on the trailing 0. It does specify that the successful return of the functions is OK.
SEE ALSO
ncurses(3NCURSES), inch(3NCURSES). Comparable functions in the wide-character (ncursesw) library are described in in_wchstr(3NCURSES). inchstr(3NCURSES)
Related Man Pages
inchnstr(3ncurses) - debian
mvwinchnstr(3ncurses) - debian
mvwinchstr(3ncurses) - debian
winchnstr(3ncurses) - suse
winchstr(3ncurses) - suse
Similar Topics in the Unix Linux Community
Change directory error
Cut command on RHEL 6.8 compatibility issues
A (ksh) Library For and From UNIX.com
The Future of the PM (Private Message) System at UNIX.com
32 bit process addressing more than 4GB