Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getstr(3) [osf1 man page]

curs_getstr(3)						     Library Functions Manual						    curs_getstr(3)

NAME
curs_getstr, getstr, getnstr, wgetstr, wgetnstr, mvgetstr, mvgetnstr, mvwgetstr, mvwgetnstr - Get character strings from a 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 mvgetnstr( int y, int x, char *str, int n ); int mvwgetstr( WINDOW *win, int y, int x, char *str ); int mvwgetnstr( WINDOW *win, int y, int x, char *str, int n ); LIBRARY
Curses Library (libcurses) STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: getnstr, wgetnstr, mvgetnstr, mvwgetnstr, getstr, wgetstr, mvgetstr, mvwgetstr: XCURSES4.2 Refer to the standards(5) reference page for more information about industry standards and associated tags. DESCRIPTION
The effect of getstr is as though a series of calls to getch were made, until a newline or carriage return is received. The resulting value is placed in the area pointed to by the character pointer str. The getnstr routine reads at most n characters, thus preventing a possible overflow of the input buffer. The user's erase and kill characters are interpreted, as well as any special keys (such as function keys, "home" key, "clear" key, and so on). The mvgetstr routine is identical to getstr except that it is as though it is a call to move and then a series of calls to getch. The mvwgetstr routine is identical to getstr except it is as though a call to wmove is made and then a series of call to wgetch. The mvgetnstr routine is identical to getnstr except that it is as though it is a call to move and then a series of calls to getch. The mvwgetnstr is identical to getnstr except it is a though a call to wmove is made and then a series of calls to wgetch. The getnstr, wgetnstr, mvgetnstr, and mvwgetnstr routines return only the entire multibyte sequence associated with a character. If the array is large enough to contain at least one character, the routines fill the array with complete characters. If the array is not large enough to contain at least one complete character, the routines fail. NOTES
The header file <curses.h> automatically includes the header file <stdio.h>. Note that all routines except wgetstr and wgetnstr may be macros. RETURN VALUES
All routines return the integer ERR upon failure and OK upon successful completion. SEE ALSO
Functions: curses(3), curs_getch(3) Others: standards(5) curs_getstr(3)

Check Out this Related Man Page

getnstr(3XCURSES)					  X/Open Curses Library Functions					 getnstr(3XCURSES)

NAME
getnstr, getstr, mvgetnstr, mvgetstr, mvwgetnstr, mvwgetstr, wgetnstr, wgetstr - get a multibyte character string from terminal 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 getnstr(char *str, int n); int getstr(char *str); int mvgetnstr(int y, int x, char *str, int n); int mvgetstr(int y, int x, char *str); int mvwgetnstr(WINDOW *win, int y, int x, char *str, int n); int mvwgetstr(WINDOW *win, int y, int x, char *str); int wgetnstr(WINDOW *win, char *str, int n); int wgetstr(WINDOW *win, char *str); DESCRIPTION
The getstr() and wgetstr() functions get a character string from the terminal associated with the window stdscr or window win, respec- tively. The mvgetstr() and mvwgetstr() functions move the cursor to the position specified in stdscr or win, respectively, then get a character string. These functions call wgetch(3XCURSES) and place each received character in str until a newline is received, which is also placed in str. The erase and kill characters set by the user are processed. The getnstr(), mvgetnstr(), mvwgetnstr() and wgetnstr() functions read at most n characters. These functions are used to prevent over- flowing the input buffer. The getnstr(), wgetnstr(), mvgetnstr(), and mvwgetnstr() functions only return complete multibyte characters. If the area pointed to by str is not large enough to hold at least one character, these functions fail. PARAMETERS
str Is a pointer to the area where the character string is to be placed. n Is the maximum number of characters to read from input. y Is the y (row) coordinate of starting position of character string to be read. x Is the x (column) coordinate of starting position of character string to be read. win Points to the window associated with the terminal from which the character is to be read. RETURN VALUES
On success, these functions return OK. Otherwise, they return ERR. ERRORS
None. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |Unsafe | +-----------------------------+-----------------------------+ SEE ALSO
getch(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5) SunOS 5.11 5 Jun 2002 getnstr(3XCURSES)
Man Page