Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
curs_getstr(3CURSES)	   Curses Library Functions	  curs_getstr(3CURSES)

NAME
       curs_getstr, getstr, wgetstr, mvgetstr, mvwgetstr, wgetnstr - get char-
       acter strings from curses terminal keyboard

SYNOPSIS
       cc [ flag ... ] file ...	-lcurses [ library ... ]
       #include	<curses.h>

       int getstr(char *str);

       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 wgetnstr(WINDOW *win, char *str, int	n);

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.
       wgetnstr() reads	at most	n characters, thus preventing a	possible over-
       flow of the input buffer.  The user's erase and kill characters are in-
       terpreted,  as  well  as	 any special keys (such	as function keys, HOME
       key, and	CLEAR key.)

RETURN VALUES
       All routines return the integer ERR upon	failure	and an	integer	 value
       other than ERR upon successful completion.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       curs_getch(3CURSES), curses(3CURSES), attributes(5)

NOTES
       The header <curses.h> automatically includes the	headers	 <stdio.h> and
       <unctrl.h>.

       Note that getstr(), mvgetstr(), and mvwgetstr() may be macros.

SunOS 5.10			  31 Dec 1996		  curs_getstr(3CURSES)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ATTRIBUTES | SEE ALSO | NOTES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=getstr&sektion=3curses&manpath=SunOS+5.10>

home | help