man/XcupQueryVersion.man

   1 .\" Copyright \(co 1986-1997   The Open Group    All Rights Reserved
   2 .\" Copyright 1999, 2005 Sun Microsystems, Inc.  All rights reserved.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a
   5 .\" copy of this software and associated documentation files (the "Software"),
   6 .\" to deal in the Software without restriction, including without limitation
   7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 .\" and/or sell copies of the Software, and to permit persons to whom the
   9 .\" Software is furnished to do so, subject to the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice (including the next
  12 .\" paragraph) shall be included in all copies or substantial portions of the
  13 .\" Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 .\" DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .\" X Window System is a trademark of The Open Group.
  24 .\"
  25 .de ZN
  26 .ie t \fB\^\\$1\^\fR\\$2
  27 .el \fI\^\\$1\^\fP\\$2
  28 ..
  29 .TH XcupQueryVersion __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  30 .SH NAME
  31 XcupQueryVersion \- Returns TOG-CUP protocol version supported by the X server
  32 .SH SYNOPSIS
  33 .PP
  34 .nf
  35 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  36 \&#include <X11/extensions/Xcup.h>
  37 .HP
  38 Status \fBXcupQueryVersion\fP\^(\^Display *\fIdisplay\fP\^,
  39 int *\fImajor_version_return\fP\^, int *\fIminor_version_return\fP\^);
  40 .if n .ti +5n
  41 .if t .ti +.5i
  42 .SH ARGUMENTS
  43 .IP \fIdisplay\fP 1i
  44 Specifies the connection to the X server
  45 .IP \fImajor_version_return\fP 1i
  46 Returns the major version supported by the server
  47 .IP \fIminor_version_return\fP 1i
  48 Returns the minor version supported by the server
  49 .SH DESCRIPTION
  50 .LP
  51 .ZN XcupQueryVersion
  52 sets
  53 .I major_version_return
  54 and
  55 .I minor_version_return
  56 to the major and minor TOG-CUP protocol version supported by the
  57 server. If the TOG-CUP library is compatible with the version returned
  58 by the server, it returns nonzero. If the server does not support the TOG-CUP
  59 extension, or if there was an error during communications with the
  60 server, or if the server and library protocol versions are
  61 incompatible, it returns zero. No other Xcup functions may be called
  62 before this function. If a client violates this rule, the effects of
  63 all subsequent Xcup calls that it makes are undefined.
  64 .LP
  65 To get the list of reserved colormap entries, use
  66 .ZN XcupGetReservedColormapEntries.
  67 .LP
  68 To allocate one or more read-only color cells with RGB values, use
  69 .ZN XcupStoreColors.
  70 .SH "SEE ALSO"
  71 .BR XcupGetReservedColormapEntries (3Xext),
  72 .BR XcupStoreColors (3Xext),
  73 .br
  74 \fIColormap Utilization Policy and Extension\fP