man/XQueryExtension.man

   1 .\"
   2 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
   3 .\" Digital Equipment Corporation
   4 .\"
   5 .\" Portions Copyright \(co 1990, 1991 by
   6 .\" Tektronix, Inc
   7 .\"
   8 .\" Rewritten for X.org by Chris Lee <clee@freedesktop.org>
   9 .\"
  10 .\" Permission to use, copy, modify, distribute, and sell this documentation
  11 .\" for any purpose and without fee is hereby granted, provided that the above
  12 .\" copyright notice and this permission notice appear in all copies.
  13 .\" Chris Lee makes no representations about the suitability for any purpose
  14 .\" of the information in this document.  It is provided \`\`as-is'' without
  15 .\" express or implied warranty.
  16 .\"
  17 .ds xL Programming with Xlib
  18 .TH XQueryExtension __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  19 .SH NAME
  20 XQueryExtension, XListExtensions, XFreeExtensionList \- list available extensions
  21 .SH SYNTAX
  22 .HP
  23 Bool XQueryExtension(\^\fIdisplay, \fIname\fP, \fImajor_opcode_return\fP, \fIfirst_event_return\fP, \fIfirst_error_return\fP\^)
  24 .HP
  25 char **XListExtensions(\^\fIdisplay\fP, \fInextensions_return\fP\^)
  26 .HP
  27 XFreeExtensionList(\^\fIlist\fP\^)
  28 .SH ARGUMENTS
  29 .IP \fIdisplay\fP 1i
  30 Specifies the connection to the X server.
  31 .IP \fIname\fP 1i
  32 Specifies the extension name.
  33 .IP \fImajor_opcode_return\fP 1i
  34 Returns the major opcode.
  35 .IP \fIfirst_event_return\fP 1i
  36 Returns the first event code, if any.
  37 .IP \fIfirst_error_return\fP 1i
  38 Returns the first error code, if any.
  39 .IP \fInextensions_return\fP 1i
  40 Returns the number of extensions listed.
  41 .IP \fIlist\fP 1i
  42 Specifies the list of extension names.
  43 .SH DESCRIPTION
  44 .LP
  45 The \fIXQueryExtension\fP function determines if the named extension is
  46 present.  If the extension is not present, \fIXQueryExtension\fP returns
  47 \fIFalse\fP; otherwise, it returns \fITrue\fP.  If the extension is present,
  48 \fIXQueryExtension\fP returns the major opcode for the extension to
  49 major_opcode_return; otherwise, it returns zero.  Any minor opcode and the
  50 request formats are specific to the extension.  If the extension involves
  51 additional event types, \fIXQueryExtension\fP returns the base event type code
  52 to first_event_return; otherwise, it returns zero. The format of the events is
  53 specific to the extension.  If the extension involves additional error codes,
  54 \fIXQueryExtension\fP returns the base error code to first_error_return;
  55 otherwise, it returns zero.  The format of additional data in the errors is
  56 specific to the extension.  If the extension name is not in the Host Portable
  57 Character Encoding the result is implementation-dependent.  Uppercase and
  58 lowercase matter; the strings ``thing'', ``Thing'', and ``thinG'' are all
  59 considered different names.
  60 .LP
  61 The \fIXListExtensions\fP function returns a list of all extensions supported
  62 by the server. If the data returned by the server is in the Latin Portable
  63 Character Encoding, then the returned strings are in the Host Portable
  64 Character Encoding. Otherwise, the result is implementation-dependent.
  65 .LP
  66 The \fIXFreeExtensionList\fP function frees the memory allocated by
  67 \fIXListExtensions\fP.