Home
Search all pages
Subjects
By activity
Professions, Sciences, Humanities, Business, ...
User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...
Text Strings
Conversions, tests, processing, manipulation,...
Math
Integer, Floating point, Matrix, Statistics, Boolean, ...
Processing
Algorithms, Memory, Process control, Debugging, ...
Stored Data
Data storage, Integrity, Encryption, Compression, ...
Communications
Networks, protocols, Interprocess, Remote, Client Server, ...
Hard World Timing, Calendar and Clock, Audio, Video, Printer, Controls...
File System
Management, Filtering, File & Directory access, Viewers, ...
|
|
|
RocketLink!--> Man page versions:
OpenBSD
FreeBSD
Others
curs_getstr(3) curs_getstr(3)
NAME
getstr, wgetstr, mvgetstr, mvwgetstr, wgetnstr - 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 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);
int wgetnstr(WINDOW *win, 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 pre-
vious 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.
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 specifies that they return ERR on failure, but
the single error condition EOVERFLOW associated with
extended-level conformance is not yet returned (the XSI
curses support for multi-byte characters is not yet
1
curs_getstr(3) curs_getstr(3)
present).
SVr3 and early SVr4 curses implementations did not reject
function keys; the SVr4.0 documentation claimed that "spe-
cial 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 pre-
sent but not documented in SVr4.
SEE ALSO
curses(3), curs_getch(3).
2
Source: OpenBSD 2.6 man pages. Copyright: Portions are copyrighted by BERKELEY SOFTWARE DESIGN, INC., The Regents of the University of California, Massachusetts Institute of Technology, Free Software Foundation, FreeBSD Inc., and others. |
(Corrections, notes, and links courtesy of RocketAware.com)
FreeBSD Sources for curs_getstr(3) functions OpenBSD sources for curs_getstr(3)
Up to: Curses - Curses (Library for text display interfaces)
RocketLink!--> Man page versions:
OpenBSD
FreeBSD
Others
Rapid-Links:
Search | About | Comments | Submit Path: RocketAware > man pages >
curs_getstr.3/
RocketAware.com is a service of Mib Software Copyright 1999, Forrest J. Cavalier III. All Rights Reserved. We welcome submissions and comments
|