instr man page on OpenBSD

Man page or keyword search:  
man Server   11362 pages
apropos Keyword Search (all sections)
Output format
OpenBSD logo
[printable version]

curs_instr(3)							 curs_instr(3)

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

SYNOPSIS
       #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, 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).

RETURN VALUE
       All of the functions return ERR upon failure, or the number of
       characters actually read into the string.

       X/Open defines no error conditions.  In this implementation, if the
       window parameter is null or the str parameter is null, a zero is
       returned.

NOTES
       Note that all routines except winnstr may be macros.

PORTABILITY
       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.

SEE ALSO
       curses(3).

								 March 1, 2011
[top]

List of man pages available for OpenBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net