man-pages/man3/XDeviceBell.3.html
2021-03-31 01:06:50 +01:00

235 lines
3.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XDEVICEBELL</TITLE>
</HEAD><BODY>
<H1>XDEVICEBELL</H1>
Section: &nbsp; (3)<BR>Updated: 06/19/2019<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
XDeviceBell - ring a bell on a device supported through the input extension
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<PRE>
#include &lt;<A HREF="file:///usr/include/X11/extensions/XInput.h">X11/extensions/XInput.h</A>&gt;
</PRE>
<P>
<PRE>
Status XDeviceBell( Display *display,
XDevice *device,
XID feedbackclass,
XID feedbackid,
int percent);
display
Specifies the connection to the X server.
</PRE>
<P>
<PRE>
device
Specifies the device with which the bell is associated.
</PRE>
<P>
<PRE>
feedbackclass
Specifies the class of the feedback with which the bell
is associated.
</PRE>
<P>
<PRE>
feedbackid
Specifies the id of the feedback with which the bell is
associated.
</PRE>
<P>
<PRE>
percent
Specifies the volume in the range -100 to 100 at which
the bell should be rung.
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DL COMPACT><DT id="1"><DD>
<PRE>
The XDeviceBell request causes the server to ring a bell on the
specified feedback of the specified device, if possible. The
specified volume is relative to the base volume for the bell.
If an invalid device is specified, a BadDevice error will be
returned. The feedbackclass and feedbackid parameters contain
values returned by an XGetFeedbackControl request and uniquely
identify the bell to ring. If a feedbackclass is specified that
does not support a bell, or if a nonexistent feedbackid is
specified, or a percent value is specified that is not in the
range -100 to 100, a BadValue error will be returned.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="2"><DD>
<PRE>
The volume at which the bell is rung when the percent argument
is nonnegative is: base - [(base * percent) / 100] + percent
</PRE>
</DL>
<P>
<DL COMPACT><DT id="3"><DD>
<PRE>
The volume at which the bell rings when the percent argument is
negative is: base + [(base * percent) / 100]
</PRE>
</DL>
<P>
<DL COMPACT><DT id="4"><DD>
<PRE>
To change the base volume of the bell, use
XChangeFeedbackControl.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="5"><DD>
<PRE>
XDeviceBell can generate a BadDevice or a BadValue error.
</PRE>
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
<P>
<DL COMPACT><DT id="6"><DD>
<PRE>
BadDevice
An invalid device was specified. The specified device
does not exist, or has not been opened by this client
via XOpenInputDevice.
</PRE>
</DL>
<P>
<DL COMPACT><DT id="7"><DD>
<PRE>
BadValue
An invalid feedbackclass, feedbackid, or percent value
was specified.
</PRE>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<DL COMPACT><DT id="8"><DD>
<PRE>
<A HREF="/cgi-bin/man/man2html?3+XChangeFeedbackControl">XChangeFeedbackControl</A>(3), <A HREF="/cgi-bin/man/man2html?3+XBell">XBell</A>(3)
</PRE>
</DL>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">DIAGNOSTICS</A><DD>
<DT id="13"><A HREF="#lbAF">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:00 GMT, March 31, 2021
</BODY>
</HTML>