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 | * Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * |
| 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_addchstr.3x,v 1.12 2006/12/02 17:02:45 tom Exp @ |
| 31 | --> |
| 32 | <HTML> |
| 33 | <HEAD> |
| 34 | <TITLE>curs_addchstr 3x</TITLE> |
| 35 | <link rev=made href="mailto:bug-ncurses@gnu.org"> |
| 36 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 37 | </HEAD> |
| 38 | <BODY> |
| 39 | <H1>curs_addchstr 3x</H1> |
| 40 | <HR> |
| 41 | <PRE> |
| 42 | <!-- Manpage converted by man2html 3.0.1 --> |
| 43 | <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> |
| 44 | |
| 45 | |
| 46 | |
| 47 | |
| 48 | </PRE> |
| 49 | <H2>NAME</H2><PRE> |
| 50 | <STRONG>addchstr</STRONG>, <STRONG>addchnstr</STRONG>, <STRONG>waddchstr</STRONG>, <STRONG>waddchnstr</STRONG>, <STRONG>mvaddchstr</STRONG>, |
| 51 | <STRONG>mvaddchnstr</STRONG>, <STRONG>mvwaddchstr</STRONG>, <STRONG>mvwaddchnstr</STRONG> - add a string of |
| 52 | characters (and attributes) to a <STRONG>curses</STRONG> window |
| 53 | |
| 54 | |
| 55 | </PRE> |
| 56 | <H2>SYNOPSIS</H2><PRE> |
| 57 | <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 58 | |
| 59 | <STRONG>int</STRONG> <STRONG>addchstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> |
| 60 | <STRONG>int</STRONG> <STRONG>addchnstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> |
| 61 | <STRONG>int</STRONG> <STRONG>waddchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> |
| 62 | <STRONG>int</STRONG> <STRONG>waddchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> |
| 63 | <STRONG>int</STRONG> <STRONG>mvaddchstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG> |
| 64 | <STRONG>int</STRONG> <STRONG>mvaddchnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> |
| 65 | <STRONG>int</STRONG> <STRONG>mvwaddchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> |
| 66 | <STRONG>*chstr);</STRONG> |
| 67 | <STRONG>int</STRONG> <STRONG>mvwaddchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> |
| 68 | <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG> |
| 69 | |
| 70 | |
| 71 | </PRE> |
| 72 | <H2>DESCRIPTION</H2><PRE> |
| 73 | These routines copy <EM>chstr</EM> into the window image structure |
| 74 | at and after the current cursor position. The four rou- |
| 75 | tines with <EM>n</EM> as the last argument copy at most <EM>n</EM> elements, |
| 76 | but no more than will fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the |
| 77 | whole string is copied, to the maximum number of charac- |
| 78 | ters that will fit on the line. |
| 79 | |
| 80 | The window cursor is <EM>not</EM> advanced, and these routines work |
| 81 | faster than <STRONG>waddnstr</STRONG>. On the other hand, they do not per- |
| 82 | form any kind of checking (such as for the newline, |
| 83 | backspace, or carriage return characters), they do not ad- |
| 84 | vance the current cursor position, they do not expand oth- |
| 85 | er control characters to ^-escapes, and they truncate the |
| 86 | string if it crosses the right margin, rather than wrap- |
| 87 | ping it around to the new line. |
| 88 | |
| 89 | |
| 90 | </PRE> |
| 91 | <H2>RETURN VALUES</H2><PRE> |
| 92 | All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on |
| 93 | success (the SVr4 manuals specify only "an integer value |
| 94 | other than <STRONG>ERR</STRONG>") upon successful completion, unless other- |
| 95 | wise noted in the preceding routine descriptions. |
| 96 | |
| 97 | X/Open does not define any error conditions. This imple- |
| 98 | mentation returns an error if the window pointer is null. |
| 99 | |
| 100 | |
| 101 | </PRE> |
| 102 | <H2>NOTES</H2><PRE> |
| 103 | Note that all routines except <STRONG>waddchnstr</STRONG> may be macros. |
| 104 | |
| 105 | |
| 106 | </PRE> |
| 107 | <H2>PORTABILITY</H2><PRE> |
| 108 | These entry points are described in the XSI Curses stan- |
| 109 | dard, Issue 4. |
| 110 | |
| 111 | |
| 112 | </PRE> |
| 113 | <H2>SEE ALSO</H2><PRE> |
| 114 | <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. |
| 115 | |
| 116 | Comparable functions in the wide-character (ncursesw) li- |
| 117 | brary are described in <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>. |
| 118 | |
| 119 | |
| 120 | |
| 121 | <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> |
| 122 | </PRE> |
| 123 | <HR> |
| 124 | <ADDRESS> |
| 125 | Man(1) output converted with |
| 126 | <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> |
| 127 | </ADDRESS> |
| 128 | </BODY> |
| 129 | </HTML> |