diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/curs_getstr.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/curs_getstr.3x.html | 134 |
1 files changed, 0 insertions, 134 deletions
diff --git a/ncurses-5.2/doc/html/man/curs_getstr.3x.html b/ncurses-5.2/doc/html/man/curs_getstr.3x.html deleted file mode 100644 index 19c8ce1..0000000 --- a/ncurses-5.2/doc/html/man/curs_getstr.3x.html +++ /dev/null @@ -1,134 +0,0 @@ -<HTML> -<BODY> -<PRE> -<!-- Manpage converted by man2html 3.0.1 --> - -</PRE> -<H2>NAME</H2><PRE> - <B>getstr</B>, <B>getnstr</B>, <B>wgetstr</B>, <B>wgetnstr</B>, <B>mvgetstr</B>, <B>mvgetnstr</B>, - <B>mvwgetstr</B>, <B>mvwgetnstr</B> - accept character strings from - <B>curses</B> terminal keyboard - - -</PRE> -<H2>SYNOPSIS</H2><PRE> - <B>#include</B> <B><curses.h></B> - - <B>int</B> <B>getstr(char</B> <B>*str);</B> - <B>int</B> <B>getnstr(char</B> <B>*str,</B> <B>int</B> <B>n);</B> - <B>int</B> <B>wgetstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str);</B> - <B>int</B> <B>wgetnstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> - <B>int</B> <B>mvgetstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B> - <B>int</B> <B>mvwgetstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B> - <B>int</B> <B>mvgetnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> - <B>int</B> <B>mvwgetnstr(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B> - - -</PRE> -<H2>DESCRIPTION</H2><PRE> - The function <B>getstr</B> is equivalent to a series of calls to - <B>getch</B>, 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 <I>str</I>. - - <B>wgetnstr</B> reads at most <I>n</I> 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 <B>getnstr</B> function reads - from the <I>stdscr</I> default window. - - The user's erase and kill characters are interpreted. If - keypad mode is on for the window, <B>KEY_LEFT</B> and - <B>KEY_BACKSPACE</B> are both considered equivalent to the user's - kill character. - - Characters input are echoed only if <B>echo</B> is currently on. - In that case, backspace is echoed as deletion of the pre- - vious character (typically a left motion). - - -</PRE> -<H2>RETURN VALUE</H2><PRE> - All routines return the integer <B>ERR</B> upon failure and an <B>OK</B> - (SVr4 specifies only "an integer value other than <B>ERR</B>") - upon successful completion. - - -</PRE> -<H2>NOTES</H2><PRE> - Note that <B>getstr</B>, <B>mvgetstr</B>, and <B>mvwgetstr</B> may be macros. - - -</PRE> -<H2>PORTABILITY</H2><PRE> - These functions are described in the XSI Curses standard, - Issue 4. They read single-byte characters only. The - standard specifies that they return <B>ERR</B> on failure, but - the single error condition <B>EOVERFLOW</B> associated with - extended-level conformance is not yet returned (the XSI - curses support for multi-byte characters is not yet pre- - sent). - - 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, <I>etc</I>.) 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 <B>getnstr</B>, <B>mvgetnstr</B>, and <B>mvwgetnstr</B> were pre- - sent but not documented in SVr4. - - -</PRE> -<H2>SEE ALSO</H2><PRE> - <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B>. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> -</BODY> -</HTML> |