curs_instr

, instr

, innstr

, winstr

, winnstr

, mvinstr

, mvinnstr

, mvwinstr

, mvwinnstr

- get a string of characters from a curses window

Synopsis

cc [ flag ... ] file ... -lcurses [ library ... ]
#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);

Description

These routines return a string of characters in str, starting at the current cursor position in the named window and ending at the right margin of the window. Attributes are stripped from the characters. The four functions with n as the last argument return the string at most n characters long.

Return Values

All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

curses(3CURSES), attributes(5)

Notes

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that all routines except winnstr() may be macros.