Imported Upstream version 1.1.3
[platform/core/uifw/libdmx.git] / man / DMXRemoveInput.man
1 .\" Copyright 2004 Red Hat Inc., Durham, North Carolina.
2 .\" All Rights Reserved.
3 .\"
4 .\" Permission is hereby granted, free of charge, to any person obtaining
5 .\" a copy of this software and associated documentation files (the
6 .\" "Software"), to deal in the Software without restriction, including
7 .\" without limitation on the rights to use, copy, modify, merge,
8 .\" publish, distribute, sublicense, and/or sell copies of the Software,
9 .\" and to permit persons to whom the Software is furnished to do so,
10 .\" subject to the following conditions:
11 .\"
12 .\" he above copyright notice and this permission notice (including the
13 .\" next paragraph) shall be included in all copies or substantial
14 .\" portions of the Software.
15 .\"
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 .\" NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
20 .\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 .\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 .\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 .\" SOFTWARE.
24 .TH DMXRemoveInput __libmansuffix__ __vendorversion__
25 .SH NAME
26 DMXRemoveInput \- detach an input
27 .SH SYNOPSIS
28 .B #include <X11/extensions/dmxext.h>
29 .sp
30 .nf
31 .BI "Bool DMXRemoveInput(Display " *dpy ,
32 .BI "                    int " id );
33 .fi
34 .SH DESCRIPTION
35 .B DMXRemoveInput()
36 detaches the input device with
37 .IR id ,
38 and all associated inputs (e.g., if the
39 .I id
40 is a backend mouse, and a keyboard is also attached to the backend, then
41 both devices will be detached).
42 .SH "RETURN VALUE"
43 .B DMXRemoveInput()
44 returns
45 .B True
46 unless there is a protocol error.
47 .PP
48 .B DMXRemoveInput()
49 can generate
50 .B BadValue
51 (if the
52 .I id
53 is not valid) and
54 .B BadAccess
55 (if the input has already been detached).
56 .SH "SEE ALSO"
57 .BR DMXAddInput "(__libmansuffix__), " DMX "(__libmansuffix__), " Xdmx (1)