ncurses 5.5
[ncurses.git] / doc / html / man / curs_beep.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2003,2005 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_beep.3x,v 1.10 2005/01/08 17:55:51 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_beep 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_beep 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>                                             <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
50        <STRONG>beep</STRONG>, <STRONG>flash</STRONG> - <STRONG>curses</STRONG> bell and screen flash routines
51
52
53 </PRE>
54 <H2>SYNOPSIS</H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>int</STRONG> <STRONG>beep(void);</STRONG>
58        <STRONG>int</STRONG> <STRONG>flash(void);</STRONG>
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        The <STRONG>beep</STRONG> and <STRONG>flash</STRONG> routines are used to alert the terminal
64        user.  The routine <STRONG>beep</STRONG> sounds an  audible  alarm  on  the
65        terminal,  if  possible;  otherwise  it flashes the screen
66        (visible bell).  The routine <STRONG>flash</STRONG> flashes the screen, and
67        if  that  is  not  possible, sounds the alert.  If neither
68        alert is possible, nothing happens.  Nearly all  terminals
69        have  an  audible  alert (bell or beep), but only some can
70        flash the screen.
71
72
73 </PRE>
74 <H2>RETURN VALUE</H2><PRE>
75        These routines return <STRONG>OK</STRONG> if they  succeed  in  beeping  or
76        flashing, <STRONG>ERR</STRONG> otherwise.
77
78
79 </PRE>
80 <H2>EXTENSIONS</H2><PRE>
81        SVr4's  beep  and flash routines always returned <STRONG>OK</STRONG>, so it
82        was not possible to tell when the beep or flash failed.
83
84
85 </PRE>
86 <H2>PORTABILITY</H2><PRE>
87        These functions are described in the XSI Curses  standard,
88        Issue  4.  Like SVr4, it specifies that they always return
89        <STRONG>OK</STRONG>.
90
91
92 </PRE>
93 <H2>SEE ALSO</H2><PRE>
94        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
95
96
97
98                                                           <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
99 </PRE>
100 <HR>
101 <ADDRESS>
102 Man(1) output converted with
103 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
104 </ADDRESS>
105 </BODY>
106 </HTML>