NAME
getstr, getnstr, wgetstr, wgetnstr, mvgetstr, mvgetnstr, mvwgetstr, mvwgetnstr - accept character strings from curses terminal keyboard
SYNOPSIS
#include <curses.h> int getstr(char *str); int getnstr(char *str, int n); int wgetstr(WINDOW *win, char *str); int wgetnstr(WINDOW *win, char *str, int n); int mvgetstr(int y, int x, char *str); int mvwgetstr(WINDOW *win, int y, int x, char *str); int mvgetnstr(int y, int x, char *str, int n); int mvwgetnstr(WINDOW *, int y, int x, char *str, int n);
DESCRIPTION
The function getstr is equivalent to a series of calls to getch, until a newline or carriage return is received (the terminating character is not included in the returned string). The resulting value is placed in the area pointed to by the character pointer str. wgetnstr reads at most n characters, thus preventing a possible overflow of the input buffer. Any attempt to enter more characters (other than the terminating newline or carriage return) causes a beep. Function keys also cause a beep and are ignored. The getnstr function reads from the stdscr default window. The user's erase and kill characters are interpreted. If keypad mode is on for the window, KEY_LEFT and KEY_BACKSPACE are both considered equivalent to the user's kill character. Characters input are echoed only if echo is currently on. In that case, backspace is echoed as deletion of the previous character (typically a left motion).
RETURN VALUE
All routines return the integer ERR upon failure and an OK (SVr4 specifies only "an integer value other than ERR") upon successful completion. X/Open defines no error conditions. In this implementation, these functions return an error if the window pointer is null, or if its timeout expires without having any data. This implementation provides an extension as well. If a SIGWINCH interrupts the function, it will return KEY_RESIZE rather than OK or ERR. 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.
NOTES
Note that getstr, mvgetstr, and mvwgetstr may be macros.
PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. They read single-byte characters only. The standard does not define any error conditions. This implementation returns ERR if the window pointer is null, or if the lower-level wgetch call returns an ERR. SVr3 and early SVr4 curses implementations did not reject function keys; the SVr4.0 documentation claimed that "special keys" (such as function keys, "home" key, "clear" key, etc.) are "interpreted", without giving details. It lied. In fact, the `character' value appended to the string by those implementations was predictable but not useful (being, in fact, the low-order eight bits of the key's KEY_ value). The functions getnstr, mvgetnstr, and mvwgetnstr were present but not documented in SVr4.
SEE ALSO
ncurses(3NCURSES), getch(3NCURSES), curses_variables(3NCURSES). getstr(3NCURSES)
More Linux Commands
manpages/sm-notify.8.html
sm-notify(8) - send reboot notifications to NFS peers.......
File locks are not part of persistent file system state. Lock state is thus lost when a host reboots. Network file systems must also detect when lock state is l
manpages/sudo.conf.5.html
sudo.conf(5) configuration for sudo front end (Man Page)....
The sudo.conf file is used to configure the sudo front end. It specifies the security policy and I/O logging plugins, debug flags as well as plugin-agnostic pat
manpages/Mail::SPF::Mech.3pm.html
Mail::SPF::Mech(3pm) - SPF record mechanism base class......
An object of class Mail::SPF::Mech represents a mechanism within an SPF record. Mail::SPF::Mech cannot be instantiated directly. Create an instance of a concret
manpages/wsyncup.3ncurses.html
wsyncup(3ncurses) - create curses windows - Linux man page
Calling newwin creates and returns a pointer to a new window with the given number of lines and columns. The upper left-hand corner of the window is at line beg
manpages/threads::shared.3pm.html
threads::shared(3pm) - Perl extension for sharing data struc
By default, variables are private to each thread, and each newly created thread gets a private copy of each existing variable. This module allows you to share v
manpages/has_il_sp.3ncurses.html
has_il_sp(3ncurses) - curses screen-pointer extension.......
This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. This feature can be added to any of th
manpages/sk98lin.4.html
sk98lin(4) - Marvell/SysKonnect Gigabit Ethernet driver v6.2
Note: This obsolete driver was removed from the kernel in version 2.6.26. sk98lin is the Gigabit Ethernet driver for Marvell and SysKonnect network adapter card
manpages/TAP::Parser::Scheduler::Spinner.3pm.html
TAP::Parser::Scheduler::Spinner(3pm) - A no-op job..........
A no-op job. Returned by TAP::Parser::Scheduler as an instruction to the harness to spin (keep executing tests) while the scheduler cant return a real job. METH
manpages/catopen.3.html
catopen(3) - open/close a message catalog - Linux man page
The function catopen() opens a message catalog and returns a catalog descriptor. The descriptor remains valid until catclose() or execve(2). If a file descripto
manpages/cvslock.1.html
cvslock(1) - lock CVS repositories - Linux manual page......
cvslock is used to lock a tree starting at directory in your CVS repository during low-level manipulation or inspection. There are various modes of operation: Y
manpages/gluTessBeginPolygon.3gl.html
gluTessBeginPolygon(3gl) - delimit a polygon description....
gluTessBeginPolygon.3gl - gluTessBeginPolygon and gluTessEndPolygon delimit the definition of a convex, concave or self-intersecting polygon. Within each gluTes
manpages/snmp_send.3.html
snmp_send(3) - netsnmp_session_api functions (Man Page).....
Snmp_sess_init prepares a netsnmp_session that sources transport characteristics and common information that will be used for a set of SNMP transactions. After
