manpagez: man pages & more
man XDeviceBell(3)
Home | html | info | man
XDeviceBell(3)                    X FUNCTIONS                   XDeviceBell(3)




NAME

       XDeviceBell  -  ring  a  bell  on  a device supported through the input
       extension


SYNTAX

       Status XDeviceBell(Display *display, XDevice  *device,  XID  *feedback-
              class, XID *feedbackid, int *percent);


ARGUMENTS

       display     Specifies the connection to the X server.

       device      Specifies the device with which the bell is associated.

       feedbackclass
                   Specifies  the class of the feedback with which the bell is
                   associated.

       feedbackid  Specifies the id of the feedback with  which  the  bell  is
                   associated.

       percent     Specifies  the volume in the range -100 to 100 at which the
                   bell should be rung.


DESCRIPTION

       The XDeviceBell request causes the server to ring a bell on the  speci-
       fied feedback of the specified device, if possible.  The specified vol-
       ume 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  XGetFeedback-
       Control request and uniquely identify the bell to ring.  If a feedback-
       class 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.

       The volume at which the bell is rung when the percent argument is  non-
       negative is:

              base - [(base * percent) / 100] + percent

       The  volume  at which the bell rings when the percent argument is nega-
       tive is:

              base + [(base * percent) / 100]

       To change the base volume of the bell, use XChangeFeedbackControl.

       XDeviceBell can generate a BadDevice or a BadValue error.


DIAGNOSTICS

       BadDevice   An invalid device was specified.  The specified device does
                   not exist, or has not been opened by this client via XOpen-
                   InputDevice.

       BadValue    An invalid feedbackclass, feedbackid, or percent value  was
                   specified.


SEE ALSO

       XChangeFeedbackControl(3), XBell(3)
       Programming With Xlib



X Version 11                      libXi 1.2.1                   XDeviceBell(3)

Mac OS X 10.6 X11 - Generated Sun Mar 7 12:30:14 CST 2010
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.