|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON |
curs_instr(3X) curs_instr(3X)
instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr,
mvwinnstr - get a string of characters from a curses window
#include <curses.h>
int instr(char *str);
int innstr(char *str, int n);
int winstr(WINDOW *win, char *str);
int winnstr(WINDOW *win, char *str, int n);
int mvinstr(int y, int x, char *str);
int mvinnstr(int y, int x, char *str, int n);
int mvwinstr(WINDOW *win, int y, int x, char *str);
int mvwinnstr(WINDOW *win, int y, int x, char *str, int n);
These routines return a string of characters in str, extracted
starting at the current cursor position in the named window.
Attributes are stripped from the characters. The four functions with
n as the last argument return a leading substring at most n
characters long (exclusive of the trailing NUL).
All of the functions return ERR upon failure, or the number of
characters actually read into the string.
X/Open Curses defines no error conditions. In this implementation:
· If the win parameter is null, an error is returned,
· If the chstr parameter is null, an error is returned,
Functions with a “mv” prefix first perform a cursor movement using
wmove, and return an error if the position is outside the window, or
if the window pointer is null.
Note that all routines except winnstr may be macros.
SVr4 does not document whether a length limit includes or excludes
the trailing NUL.
The ncurses library extends the XSI description by allowing a
negative value for n. In this case, the functions return the string
ending at the right margin.
curses(3X).
This page is part of the ncurses (new curses) project. Information
about the project can be found at
⟨https://www.gnu.org/software/ncurses/ncurses.html⟩. If you have a
bug report for this manual page, send it to
bug-ncurses-request@gnu.org. This page was obtained from the
project's upstream Git mirror of the CVS repository
⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-07-05. If you
discover any rendering problems in this HTML version of the page, or
you believe there is a better or more up-to-date source for the page,
or you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
curs_instr(3X)