inchstr, inchnstr, winchstr, winchnstr, mvinchstr,
mvinchnstr, mvwinchstr, mvwinchnstr - get a string of
characters (and attributes) from a curses window
-
These routines return a NULL-terminated array of chtype
quantities, starting at the current cursor position in the
named window and ending at the right margin of the window.
@@ -80,51 +77,59 @@
the chstr [see curs_inch(3x)].
-
All routines return the integer ERR upon failure and an
integer value other than ERR upon successful completion
(the number of characters retrieved, exclusive of the
trailing 0).
- No error conditions are defined. If the chstr parameter
- is null, no data is returned, and the return value is ze-
- ro.
+ X/Open Curses defines no error conditions. In this imple-
+ mentation:
- Functions with a "mv" prefix first perform a cursor move-
- ment using wmove, and return an error if the position is
+ o If the win parameter is null, an error is returned,
+
+ o If the chstr parameter is null, an error is returned,
+
+ Functions with a "mv" prefix first perform a cursor move-
+ ment using wmove, and return an error if the position is
outside the window, or if the window pointer is null.
-
-
NOTES
- Note that all routines except winchnstr may be macros.
- SVr4 does not document whether the result string is zero-
- terminated; it does not document whether a length limit
+
+ Note that all routines except winchnstr may be macros.
+ SVr4 does not document whether the result string is zero-
+ terminated; it does not document whether a length limit
argument includes any trailing 0; and it does not document
the meaning of the return value.
-
-
PORTABILITY
- These functions are described in the XSI Curses standard,
- Issue 4. It is no more specific than the SVr4 documenta-
+
+ These functions are described in the XSI Curses standard,
+ Issue 4. It is no more specific than the SVr4 documenta-
tion on the trailing 0. It does specify that the success-
ful return of the functions is OK.
-