- 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).
+ These routines return a string of characters in str, 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).
+ Transfer stops at the end of the current line, or when n characters
+ have been stored at the location referenced by str.
- All of the functions return ERR upon failure, or the number of
+ All of the functions return ERR upon failure, or the number of
characters actually read into the string.
- X/Open Curses defines no error conditions. In this implementation:
+ X/Open Curses defines no error conditions. This implementation returns
+ an error
- o If the win parameter is null, an error is returned,
+ o if the win parameter is null or
- o If the chstr parameter is null, an error is returned,
+ o if the chstr parameter is null.
- Functions with a "mv" prefix first perform a cursor movement using
- wmove, and return an error if the position is outside the window, or if
- the window pointer is null.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.
- Note that all routines except winnstr may be macros.
+ All routines except winnstr may be macros.
+
+ Reading a line that overflows the array pointed to by str with instr,
+ mvinstr, mvwinstr or winstr causes undefined results. Therefore, the
+ use of innstr, mvinnstr, mvwinnstr, or winnstr is recommended.
- SVr4 does not document whether a length limit includes or excludes the
+ 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.
+ The ncurses library extends the X/Open Curses description by allowing a
+ negative value for n. In this case, the functions return the string
+ ending at the right margin.