doc/html/man/curs_beep.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018,2020 Thomas E. Dickey                                     *
   4   * Copyright 1998-2005,2010 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.14 2020/02/02 23:34:34 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_beep 3x</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_beep 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>                                                    <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>beep</STRONG>, <STRONG>flash</STRONG> - <STRONG>curses</STRONG> bell and screen flash routines
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>beep(void);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>flash(void);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        The  <STRONG>beep</STRONG>  and <STRONG>flash</STRONG> routines are used to alert the terminal user.  The
  62        routine <STRONG>beep</STRONG> sounds an audible alarm on the terminal, if possible; oth-
  63        erwise it flashes the screen (visible bell).  The routine <STRONG>flash</STRONG> flashes
  64        the screen, and if that is not possible, sounds the alert.  If  neither
  65        alert is possible, nothing happens.  Nearly all terminals have an audi-
  66        ble alert (bell or beep), but only some can flash the screen.
  67
  68
  69 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  70        These routines return <STRONG>OK</STRONG> if they succeed in beeping  or  flashing,  <STRONG>ERR</STRONG>
  71        otherwise.
  72
  73
  74 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
  75        SVr4's beep and flash routines always returned <STRONG>OK</STRONG>, so it was not possi-
  76        ble to tell when the beep or flash failed.
  77
  78
  79 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  80        These functions are described in the  XSI  Curses  standard,  Issue  4.
  81        Like SVr4, it specifies that they always return <STRONG>OK</STRONG>.
  82
  83
  84 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  85        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
  86
  87
  88
  89                                                                  <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
  90 </PRE>
  91 <div class="nav">
  92 <ul>
  93 <li><a href="#h2-NAME">NAME</a></li>
  94 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
  95 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
  96 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
  97 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
  98 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
  99 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 100 </ul>
 101 </div>
 102 </BODY>
 103 </HTML>