1.\" $NetBSD: curses_echochar.3,v 1.2 2004/03/28 12:23:21 wiz Exp $ 2.\" Copyright (c) 2004 The NetBSD Foundation, Inc. 3.\" All rights reserved. 4.\" 5.\" This code is derived from software contributed to The NetBSD Foundation 6.\" by Julian Coleman. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. Neither the name of The NetBSD Foundation nor the names of its 17.\" contributors may be used to endorse or promote products derived 18.\" from this software without specific prior written permission. 19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29.\" POSSIBILITY OF SUCH DAMAGE. 30.\" 31.Dd March 27, 2004 32.Dt CURSES_ECHOCHAR 3 33.Os 34.Sh NAME 35.Nm curses_echochar , 36.Nm echochar , 37.Nm wechochar , 38.Nm pechochar 39.Nd curses add characters and then refresh routines 40.Sh LIBRARY 41.Lb libcurses 42.Sh SYNOPSIS 43.In curses.h 44.Ft int 45.Fn echochar "const chtype ch" 46.Ft int 47.Fn wechochar "WINDOW *win" "const chtype ch" 48.Ft int 49.Fn pechochar "WINDOW *pad" "const chtype ch" 50.Sh DESCRIPTION 51These functions add characters to 52.Dv stdscr 53or to the specified window or pad and then cause an immediate 54.Fn refresh 55of that window or pad. 56.Pp 57The 58.Fn echochar 59function adds the character given in 60.Fa ch 61to 62.Dv stdscr 63at the current cursor position and advances the current cursor position by one. 64Any character attributes set in 65.Fa ch 66will be merged with the background attributes currently set on 67.Dv stdscr . 68.Dv stdscr 69is then refreshed. 70Calling 71.Fn echochar 72is equivalent to calling 73.Fn addch 74followed by 75.Fn refresh . 76.Pp 77The 78.Fn wechochar 79function is the same as the 80.Fn echochar 81function, excepting that the character is added to the window specified by 82.Fa win 83and 84.Fa win 85is refreshed. 86.Pp 87The 88.Fn pechochar 89function is the similar to the 90.Fn echochar 91function, excepting that the character is added to the pad specified by 92.Fa pad 93and 94.Fa pad 95is refreshed at its previous location on the screen. 96Calling 97.Fn pechochar 98is equivalent to calling 99.Fn addch 100followed by 101.Fn prefresh . 102.Sh RETURN VALUES 103These functions will return one of the following values: 104.Pp 105.Bl -tag -width ERR -compact 106.It Er OK 107The function completed successfully. 108.It Er ERR 109An error occurred in the function. 110.El 111.Sh SEE ALSO 112.Xr curses_addch 3 , 113.Xr curses_attributes 3 , 114.Xr curses_pad 3 , 115.Xr curses_refresh 3 116.Sh STANDARDS 117The 118.Fn echochar , 119.Fn wechochar , 120and 121.Fn pechochar 122functions comply with the X/Open Curses specification, part of the 123Single Unix Specification. 124.Sh HISTORY 125The Curses package appeared in 126.Bx 4.0 . 127