curs_instr(S-osr5)

curs_instr: instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr, mvwinnstr -- get a string of characters from a curses window

Syntax

cc ... -lcurses

#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 the string of characters in str starting at the current cursor position in the specified 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 on failure and an integer value other than ERR on successful completion.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

All the routines except winnstr(S-osr5) can be macros.

Files

/usr/lib/libcurses.a: the library

Standards conformance

innstr(S-osr5), instr(S-osr5), mvinnstr(S-osr5), mvinstr(S-osr5), mvwinnstr(S-osr5) mvwinstr(S-osr5), winnstr(S-osr5), and winstr(S-osr5), are not part of any currently supported standard; they are extensions of AT&T System V developed by The Santa Cruz Operation, Inc. and maintained by The SCO Group.