INCHNSTR(3XCURSES) X/Open Curses Library Functions INCHNSTR(3XCURSES)
NAME
inchnstr, inchstr, mvinchnstr, mvinchstr, mvwinchnstr, mvwinchstr,
winchnstr, winchstr - retrieve a single-byte character string (with
rendition)
SYNOPSIS
cc [
flag... ]
file...
-I /usr/xpg4/include
-L /usr/xpg4/lib \
-R /usr/xpg4/lib
-lcurses [
library... ]
c89 [
flag... ]
file...
-lcurses [
library... ]
#include <curses.h>
int inchnstr(
chtype *chstr,
int n);
int inchstr(
chtype *chstr);
int mvinchnstr(
int y,
int x,
chtype *chstr,
int n);
int mvinchstr(
int y,
int x,
chtype *chstr);
int mvwinchnstr(
WINDOW *win,
int y,
int x,
chtype *chstr,
int n);
int mvwinchstr(
WINDOW *win,
int y,
int x,
chtype *chstr);
int winchnstr(
WINDOW *win,
chtype *chstr,
int n);
int winchstr(
WINDOW *win,
chtype *chstr);
DESCRIPTION
The
inchstr() and
winchstr() functions retrieve the character string
(with rendition) starting at the current cursor position of the
stdscr window and window
win, respectively, and ending at the right
margin. The
mvinchstr() and
mvwinchstr() functions retrieve 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
inchnstr(),
winchnstr(),
mvinchnstr(), and
mvwinchnstr() functions retrieve at most
n characters from the window
stdscr and
win, respectively. The former two functions retrieve the string,
starting at the current cursor position; the latter two commands
retrieve the string, starting at the position specified by the
x and
y parameters.
All these functions store the retrieved character string in the
object pointed to by
chstr.
The complete character/attribute pair is retrieved. The character or
attributes can be extracted by performing a bitwise AND on the
retrieved value, using the constants
A_CHARTEXT,
A_ATTRIBUTES, and
A_COLOR. The character string can also be retrieved without
attributes by using
instr(3XCURSES) set of functions.
PARAMETERS
chstr Is a pointer to an object that can hold the retrieved
character string.
n Is the number of characters not to exceed when retrieving
chstr.
y Is the y (row) coordinate of the starting position of the
string to be retrieved.
x Is the x (column) coordinate of the starting position of the
string to be retrieved.
win Is a pointer to the window in which the string is to be
retrieved.
RETURN VALUES
On success, these functions return
OK. Otherwise, they return
ERR.
ERRORS
None.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+
SEE ALSO
inch(3XCURSES),
innstr(3XCURSES),
libcurses(3XCURSES),
attributes(7),
standards(7) June 5, 2002 INCHNSTR(3XCURSES)
