Blame - doc/html/man/curs_inchstr.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_inchstr.3x,v 1.12 2006/12/02 17:00:58 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_inchstr 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_inchstr 3x</H1>

40

<HR>

41

<PRE>

42

43

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

</PRE>

inchstr, inchnstr, winchstr, winchnstr, mvinchstr,

51

mvinchnstr, mvwinchstr, mvwinchnstr - get a string of

52

characters (and attributes) from a curses window

</PRE>

<H2>SYNOPSIS</H2><PRE>

57

#include <curses.h>

58

59

int inchstr(chtype *chstr);

60

int inchnstr(chtype *chstr, int n);

61

int winchstr(WINDOW *win, chtype *chstr);

62

int winchnstr(WINDOW *win, chtype *chstr, int n);

63

int mvinchstr(int y, int x, chtype *chstr);

64

int mvinchnstr(int y, int x, chtype *chstr, int n);

65

int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);

66

int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr,

int n);

</PRE>

<H2>DESCRIPTION</H2><PRE>

72

These routines return a NULL-terminated array of chtype

73

quantities, starting at the current cursor position in the

74

named window and ending at the right margin of the window.

75

The four functions with n as the last argument, return a

76

leading substring at most n characters long (exclusive of

77

the trailing (chtype)0). Constants defined in <curses.h>

78

can be used with the & (logical AND) operator to extract

79

the character or the attribute alone from any position in

80

the chstr [see <A HREF="curs_inch.3x.html">curs_inch(3x)</A>].

</PRE>

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

85

All routines return the integer ERR upon failure and an

86

integer value other than ERR upon successful completion

87

(the number of characters retrieved, exclusive of the

88

trailing 0).

89

90

No error conditions are defined. If the chstr parameter

91

is null, no data is returned, and the return value is ze-

ro.

</PRE>

<H2>NOTES</H2><PRE>

Note that all routines except winchnstr may be macros.

98

SVr4 does not document whether the result string is 0-ter-

99

minated; it does not document whether a length limit argu-

100

ment includes any trailing 0; and it does not document the

101

meaning of the return value.

</PRE>

<H2>PORTABILITY</H2><PRE>

106

These functions are described in the XSI Curses standard,

107

Issue 4. It is no more specific than the SVr4 documenta-

108

tion on the trailing 0. It does specify that the success-

109

ful return of the functions is OK.

</PRE>

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

115

116

Comparable functions in the wide-character (ncursesw) li-

117

brary are described in <A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A>.

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

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>