curs_getstr man page on DigitalUNIX

Man page or keyword search:  
man Server   12896 pages
apropos Keyword Search (all sections)
Output format
DigitalUNIX logo
[printable version]

curs_getstr(3X)						       curs_getstr(3X)

       getstr,	getnstr,  wgetstr,  wgetnstr,  mvgetstr, mvgetnstr, mvwgetstr,
       mvwgetnstr - accept character strings from curses terminal keyboard

       #include <ncurses.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);

       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 over‐
       flow of the input buffer.  Any attempt to enter more characters	(other
       than  the terminating newline or carriage return) causes a beep.	 Func‐
       tion 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	(typi‐
       cally a left motion).

       All routines return the integer ERR upon failure and an OK (SVr4 speci‐
       fies only "an integer value other than ERR")  upon  successful  comple‐

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

       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 present).

       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.

       curses(3X), curs_getch(3X).


List of man pages available for DigitalUNIX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net