Blame - doc/html/man/curs_instr.3x.html - android_external_libncurses

Amit Daniel Kachhap

e6a01f5

2011-07-20 11:45:59 +0530

[diff] [blame^]

1

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">

2

<!--

3

****************************************************************************

4

5

* *

6

* Permission is hereby granted, free of charge, to any person obtaining a *

7

* copy of this software and associated documentation files (the *

8

* "Software"), to deal in the Software without restriction, including *

9

* without limitation the rights to use, copy, modify, merge, publish, *

10

* distribute, distribute with modifications, sublicense, and/or sell *

11

* copies of the Software, and to permit persons to whom the Software is *

12

* furnished to do so, subject to the following conditions: *

13

* *

14

* The above copyright notice and this permission notice shall be included *

15

* in all copies or substantial portions of the Software. *

16

* *

17

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

18

* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

19

* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

20

* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

21

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

22

* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

23

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

24

* *

25

* Except as contained in this notice, the name(s) of the above copyright *

26

* holders shall not be used in advertising or otherwise to promote the *

27

* sale, use or other dealings in this Software without prior written *

28

* authorization. *

29

****************************************************************************

30

* @Id: curs_instr.3x,v 1.13 2006/02/25 21:49:19 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_instr 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_instr 3x</H1>

40

<HR>

41

<PRE>

42

43

<A HREF="curs_instr.3x.html">curs_instr(3x)</A> <A HREF="curs_instr.3x.html">curs_instr(3x)</A>

</PRE>

instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin-

51

str, mvwinnstr - get a string of characters from a curses

window

</PRE>

<H2>SYNOPSIS</H2><PRE>

57

#include <curses.h>

58

59

int instr(char *str);

60

int innstr(char *str, int n);

61

int winstr(WINDOW *win, char *str);

62

int winnstr(WINDOW *win, char *str, int n);

63

int mvinstr(int y, int x, char *str);

64

int mvinnstr(int y, int x, char *str, int n);

65

int mvwinstr(WINDOW *win, int y, int x, char *str);

66

int mvwinnstr(WINDOW *win, int y, int x, char *str, int

n);

</PRE>

<H2>DESCRIPTION</H2><PRE>

72

These routines return a string of characters in str,

73

extracted starting at the current cursor position in the

74

named window. Attributes are stripped from the charac-

75

ters. The four functions with n as the last argument

76

return a leading substring at most n characters long

77

(exclusive of the trailing NUL).

</PRE>

<H2>RETURN VALUE</H2><PRE>

82

All of the functions return ERR upon failure, or the num-

83

ber of characters actually read into the string.

84

85

X/Open defines no error conditions. In this implementa-

86

tion, if the window parameter is null or the str parameter

87

is null, a zero is returned.

</PRE>

<H2>NOTES</H2><PRE>

Note that all routines except winnstr may be macros.

</PRE>

<H2>PORTABILITY</H2><PRE>

97

SVr4 does not document whether a length limit includes or

98

excludes the trailing NUL.

99

100

The ncurses library extends the XSI description by allow-

101

ing a negative value for n. In this case, the functions

102

return the string ending at the right margin.

</PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>.

<A HREF="curs_instr.3x.html">curs_instr(3x)</A>

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>