instr winstr innstr winnstr mvinstr mvwinstr mvinnstr mvwinnstr

The instr set of routines is used to return a character string (without attributes).

Syntax

   #include <curses.h>



   int instr(char *str);

   int winstr(WINDOW *win, char *str);



   int innstr(char *str, int n);

   int winnstr(WINDOW *win, char *str, int n);



   int mvinstr(int y, int x, char *str);

   int mvwinstr(WINDOW *win, int y, int x, char *str);



   int mvinnstr(int y, int x, char *str, int n);

   int mvwinnstr(WINDOW *win, int y, int x, char *str, int n);

Parameters

n: The number of characters not to exceed when returning str.
str: A character string to be returned.
win: A pointer to the window in which the string is to be returned.
x: The x (column) coordinate of the starting position of the string to be returned.
y: The y (row) coordinate of the starting position of the string to be returned.

Return Values

OK: Successful completion.
ERR: An error occurred.

Description

The instr() and winstr() routines return the character string (without attributes) starting at the current cursor position of the stdscr window and window win, respectively, and ending at the right margin. The mvinstr() and mvwinstr() routines return the character string located at the position indicated by the x (column) and y (row) parameters (the former in the stdscr window; the latter in window win).

The innstr(), winnstr(), mvinnstr(), and mvwinnstr() routines return at most n characters from the window stdscr and win, respectively. The former two routines return the string starting at the current cursor position; the latter two commands return the string, starting at the position specified by the x and y parameters.

Only the character portion of the character/attribute pair is returned. To return the complete character/attribute pair, use winchstr().




	NOTE: All routines except `winnstr()` are macros.

Implementation Considerations

UNIX System V implementation

Portability

UNIX System V

instr winstr innstr winnstr mvinstr mvwinstr mvinnstr mvwinnstr

Technical documentation

» Table of Contents

» Index