libXext-1.0.2/man/XcupQueryVersion.man

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