41ea86d34b697edcf405f44a949b7351d83be40d
[ncurses.git] / doc / html / man / curs_beep.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_beep.3x,v 1.12 2010/12/04 18:36:44 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_beep 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_beep 3x</H1>
42 <PRE>
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><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>beep</STRONG>, <STRONG>flash</STRONG> - <STRONG>curses</STRONG> bell and screen flash routines
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55        <STRONG>int</STRONG> <STRONG>beep(void);</STRONG>
56        <STRONG>int</STRONG> <STRONG>flash(void);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        The  <STRONG>beep</STRONG>  and <STRONG>flash</STRONG> routines are used to alert the terminal user.  The
61        routine <STRONG>beep</STRONG> sounds an audible alarm on the terminal, if possible; oth-
62        erwise it flashes the screen (visible bell).  The routine <STRONG>flash</STRONG> flashes
63        the screen, and if that is not possible, sounds the alert.  If  neither
64        alert is possible, nothing happens.  Nearly all terminals have an audi-
65        ble alert (bell or beep), but only some can flash the screen.
66
67
68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
69        These routines return <STRONG>OK</STRONG> if they succeed in beeping  or  flashing,  <STRONG>ERR</STRONG>
70        otherwise.
71
72
73 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
74        SVr4's beep and flash routines always returned <STRONG>OK</STRONG>, so it was not possi-
75        ble to tell when the beep or flash failed.
76
77
78 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
79        These functions are described in the  XSI  Curses  standard,  Issue  4.
80        Like SVr4, it specifies that they always return <STRONG>OK</STRONG>.
81
82
83 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
84        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
85
86
87
88                                                                  <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
89 </PRE>
90 <div class="nav">
91 <ul>
92 <li><a href="#h2-NAME">NAME</a></li>
93 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
94 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
95 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
96 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
97 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
98 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
99 </ul>
100 </div>
101 </BODY>
102 </HTML>