This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



curs_instr(3X)                                                                                curs_instr(3X)



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  posi-tion position
       tion 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(3X).



                                                                                              curs_instr(3X)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you? Yes It's good, but... Not helpful...