← Back to branch summary

~ubuntu-branches/ubuntu/lucid/libdmx/lucid

« back to all changes in this revision

Viewing changes to man/DMXAddScreen.3

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Stone
  • Date: 2005-07-23 00:27:06 UTC
  • Revision ID: james.westby@ubuntu.com-20050723002706-gsdqrcrjekudn09a
Tags: upstream-7.0.0
Import upstream version 7.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/DMXAddScreen.3
 
1
.\" $XFree86$
 
2
.\"
 
3
.\" Copyright 2004 Red Hat Inc., Durham, North Carolina.
 
4
.\" All Rights Reserved.
 
5
.\"
 
6
.\" Permission is hereby granted, free of charge, to any person obtaining
 
7
.\" a copy of this software and associated documentation files (the
 
8
.\" "Software"), to deal in the Software without restriction, including
 
9
.\" without limitation on the rights to use, copy, modify, merge,
 
10
.\" publish, distribute, sublicense, and/or sell copies of the Software,
 
11
.\" and to permit persons to whom the Software is furnished to do so,
 
12
.\" subject to the following conditions:
 
13
.\"
 
14
.\" he above copyright notice and this permission notice (including the
 
15
.\" next paragraph) shall be included in all copies or substantial
 
16
.\" portions of the Software.
 
17
.\"
 
18
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
19
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
20
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 
21
.\" NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
 
22
.\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 
23
.\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 
24
.\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
25
.\" SOFTWARE.
 
26
.TH DMXAddScreen 3X __vendorversion__
 
27
.SH NAME
 
28
DMXAddScreen \- attach a new back-end screen
 
29
.SH SYNOPSIS
 
30
.B #include <X11/extensions/dmxext.h>
 
31
.sp
 
32
.nf
 
33
.BI "Bool DMXAddScreen(Display " *dpy ,
 
34
.BI "                  const char " *displayName ,
 
35
.BI "                  unsigned int " mask ,
 
36
.BI "                  DMXScreenAttributes " *attr ,
 
37
.BI "                  int " *screen );
 
38
.fi
 
39
.SH DESCRIPTION
 
40
.B DMXAddScreen()
 
41
attaches a back-end screen to the
 
42
.BR Xdmx (1)
 
43
server, in place of the previously detached back-end server specified by
 
44
.IR screen .
 
45
.PP
 
46
.I displayName
 
47
is the name of the new back-end display,
 
48
.I mask
 
49
specifies the field in
 
50
.I attr
 
51
that are active, and
 
52
.I screen
 
53
returns the new
 
54
.BR Xdmx (1)
 
55
screen number for the attached screen.
 
56
.PP
 
57
The information stored in
 
58
.I mask " and " attr
 
59
is identical to that used by the
 
60
.BR DMXChangeScreenAttributes (3X)
 
61
and
 
62
.BR DMXGetScreenAttribues (3X)
 
63
functions.
 
64
.SH "RETURN VALUE"
 
65
.B DMXAddScreen()
 
66
will return
 
67
.B True
 
68
if the screen was successfully attached, and
 
69
.B False
 
70
otherwise.
 
71
.B False
 
72
will be returned if the
 
73
.I \-addremovescreens
 
74
command line option was not specified on the
 
75
.BR Xdmx (1)
 
76
command line, the input value of
 
77
.I screen
 
78
is out of range,
 
79
.I screen
 
80
is not currently detached,
 
81
.I displayName
 
82
cannot be opened, has unexpected visuals, or has characteristics that do
 
83
not match the previously detached screen.
 
84
.PP
 
85
.B DMXAddScreen()
 
86
can generate
 
87
.BR BadLength ,
 
88
.BR BadAlloc ,
 
89
and
 
90
.B BadValue
 
91
errors.
 
92
.SH NOTES
 
93
Attributes that are not specified will default to 0.  This may lead to
 
94
unintended results.
 
95
.PP
 
96
Unlike other functions in the
 
97
.BR DMX (3X)
 
98
API, this function uses
 
99
.I screen
 
100
for both input and output.
 
101
.SH "SEE ALSO"
 
102
.BR DMXRemoveScreen "(3X), "
 
103
.BR DMXChangeScreenAttributes "(3X), " DMXGetScreenAttributes "(3X), "
 
104
.BR DMX "(3X), " Xdmx (1)