man/XOpenDisplay.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XOpenDisplay __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XOpenDisplay, XCloseDisplay \- connect or disconnect to X server
 145 .SH SYNTAX
 146 .HP
 147 Display *XOpenDisplay\^(\^char *\fIdisplay_name\fP\^);
 148 .HP
 149 int XCloseDisplay\^(Display *\fIdisplay\fP\^);
 150 .SH ARGUMENTS
 151 .IP \fIdisplay\fP 1i
 152 Specifies the connection to the X server.
 153 .IP \fIdisplay_name\fP 1i
 154 Specifies the hardware display name, which determines the display
 155 and communications domain to be used.
 156 On a POSIX-conformant system, if the display_name is NULL,
 157 it defaults to the value of the DISPLAY environment variable.
 158 .IN "Environment" "DISPLAY"
 159 .SH DESCRIPTION
 160 The
 161 .ZN XOpenDisplay
 162 function returns a
 163 .ZN Display
 164 structure that serves as the
 165 connection to the X server and that contains all the information
 166 about that X server.
 167 .ZN XOpenDisplay
 168 connects your application to the X server through TCP
 169 or DECnet communications protocols,
 170 or through some local inter-process communication protocol.
 171 .IN "Protocol" "TCP"
 172 .IN "Protocol" "DECnet"
 173 If the hostname is a host machine name and a single colon (:)
 174 separates the hostname and display number,
 175 .ZN XOpenDisplay
 176 connects using TCP streams.
 177 If the hostname is not specified,
 178 Xlib uses whatever it believes is the fastest transport.
 179 If the hostname is a host machine name and a double colon (::)
 180 separates the hostname and display number,
 181 .ZN XOpenDisplay
 182 connects using DECnet.
 183 A single X server can support any or all of these transport mechanisms
 184 simultaneously.
 185 A particular Xlib implementation can support many more of these transport
 186 mechanisms.
 187 .LP
 188 .IN "Display"
 189 If successful,
 190 .ZN XOpenDisplay
 191 returns a pointer to a
 192 .ZN Display
 193 structure,
 194 which is defined in
 195 .hN X11/Xlib.h .
 196 If
 197 .ZN XOpenDisplay
 198 does not succeed, it returns NULL.
 199 After a successful call to
 200 .ZN XOpenDisplay ,
 201 all of the screens in the display can be used by the client.
 202 The screen number specified in the display_name argument is returned
 203 by the
 204 .ZN DefaultScreen
 205 macro (or the
 206 .ZN XDefaultScreen
 207 function).
 208 You can access elements of the
 209 .ZN Display
 210 and
 211 .ZN Screen
 212 structures only by using the information macros or functions.
 213 For information about using macros and functions to obtain information from
 214 the
 215 .ZN Display
 216 structure,
 217 see section 2.2.1.
 218 .LP
 219 The
 220 .ZN XCloseDisplay
 221 function closes the connection to the X server for the display specified in the
 222 .ZN Display
 223 structure and destroys all windows, resource IDs
 224 .Pn ( Window ,
 225 .ZN Font ,
 226 .ZN Pixmap ,
 227 .ZN Colormap ,
 228 .ZN Cursor ,
 229 and
 230 .ZN GContext ),
 231 or other resources that the client has created
 232 on this display, unless the close-down mode of the resource has been changed
 233 (see
 234 .ZN XSetCloseDownMode ).
 235 Therefore, these windows, resource IDs, and other resources should never be
 236 referenced again or an error will be generated.
 237 Before exiting, you should call
 238 .ZN XCloseDisplay
 239 explicitly so that any pending errors are reported as
 240 .ZN XCloseDisplay
 241 performs a final
 242 .ZN XSync
 243 operation.
 244 .IN "Resource IDs"
 245 .IN "XCloseDisplay"
 246 .LP
 247 .ZN XCloseDisplay
 248 can generate a
 249 .ZN BadGC
 250 error.
 251 .SH "SEE ALSO"
 252 AllPlanes(__libmansuffix__),
 253 XFlush(__libmansuffix__),
 254 XSetCloseDownMode(__libmansuffix__)
 255 .br
 256 \fI\*(xL\fP