Blame - doc/html/man/curs_addstr.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_addstr.3x,v 1.13 2005/05/15 16:17:14 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_addstr 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_addstr 3x</H1>

40

<HR>

41

<PRE>

42

43

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

</PRE>

addstr, addnstr, waddstr, waddnstr, mvaddstr, mvaddnstr,

51

mvwaddstr, mvwaddnstr - add a string of characters to a

52

curses window and advance cursor

</PRE>

<H2>SYNOPSIS</H2><PRE>

57

#include <curses.h>

58

59

int addstr(const char *str);

60

int addnstr(const char *str, int n);

61

int waddstr(WINDOW *win, const char *str);

62

int waddnstr(WINDOW *win, const char *str, int n);

63

int mvaddstr(int y, int x, const char *str);

64

int mvaddnstr(int y, int x, const char *str, int n);

65

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

66

int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n);

</PRE>

<H2>DESCRIPTION</H2><PRE>

71

These routines write the characters of the (null-terminat-

72

ed) character string str on the given window. It is simi-

73

lar to calling waddch once for each character in the

74

string. The four routines with n as the last argument

75

write at most n characters. If n is -1, then the entire

76

string will be added, up to the maximum number of charac-

77

ters that will fit on the line, or until a terminating

null is reached.

</PRE>

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

83

All routines return the integer ERR upon failure and OK on

84

success (the SVr4 manuals specify only "an integer value

85

other than ERR") upon successful completion.

86

87

X/Open does not define any error conditions. This imple-

88

mentation returns an error if the window pointer is null

89

or if the string pointer is null or if the corresponding

90

calls to waddch return an error.

</PRE>

<H2>NOTES</H2><PRE>

Note that all of these routines except waddstr and

96

waddnstr may be macros.

</PRE>

<H2>PORTABILITY</H2><PRE>

101

All these entry points are described in the XSI Curses

102

standard, Issue 4. The XSI errors EILSEQ and EOVERFLOW,

103

associated with extended-level conformance, are not yet

detected.

</PRE>

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

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

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>