man/DPMSQueryExtension.man

   1 .\" Copyright \(co Digital Equipment Corporation, 1996
   2 .\"
   3 .\" Permission to use, copy, modify, distribute, and sell this
   4 .\" documentation for any purpose is hereby granted without fee,
   5 .\" provided that the above copyright notice and this permission
   6 .\" notice appear in all copies.  Digital Equipment Corporation
   7 .\" makes no representations about the suitability for any purpose
   8 .\" of the information in this document.  This documentation is
   9 .\" provided ``as is'' without express or implied warranty.
  10 .\"
  11 .\" Copyright 1999, 2005 Sun Microsystems, Inc.  All rights reserved.
  12 .\"
  13 .\" Permission is hereby granted, free of charge, to any person obtaining a
  14 .\" copy of this software and associated documentation files (the "Software"),
  15 .\" to deal in the Software without restriction, including without limitation
  16 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
  17 .\" and/or sell copies of the Software, and to permit persons to whom the
  18 .\" Software is furnished to do so, subject to the following conditions:
  19 .\"
  20 .\" The above copyright notice and this permission notice (including the next
  21 .\" paragraph) shall be included in all copies or substantial portions of the
  22 .\" Software.
  23 .\"
  24 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  27 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  29 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  30 .\" DEALINGS IN THE SOFTWARE.
  31 .\"
  32 .\" X Window System is a trademark of The Open Group.
  33 .\"
  34 .TH DPMSQueryExtension __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSQueryExtension \- queries the X server to determine the availability
  37 of the DPMS Extension
  38 .SH SYNOPSIS
  39 .PP
  40 .nf
  41 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  42 \&#include <X11/extensions/dpms.h>
  43 .HP
  44 .B Bool DPMSQueryExtension
  45 (
  46 .br
  47       Display \fI*display\fP\^,
  48 .br
  49       int \fI*event_base\fP\^,
  50 .br
  51       int \fI*error_base\fP\^
  52 );
  53 .if n .ti +5n
  54 .if t .ti +.5i
  55 .SH ARGUMENTS
  56 .TP
  57 .I display
  58 Specifies the connection to the X server
  59 .TP
  60 .I event_base
  61 Specifies the return location for the assigned base event
  62 .TP
  63 .I error_base
  64 Specifies the return location for the assigned base error
  65 .SH DESCRIPTION
  66 .LP
  67 The
  68 .I DPMSQueryExtension
  69 function queries the X server to determine the availability of the
  70 Display Power Management Signaling (DPMS)
  71 Extension.  If the extension is available, it returns TRUE, and the
  72 .I event_base
  73 and
  74 .I error_base
  75 are set to the base event and error numbers, respectively.  Otherwise, the
  76 return value is FALSE, and the
  77 values of
  78 .I event_base
  79 and
  80 .I error_base
  81 are undefined.
  82 .SH "RETURN VALUES"
  83 .TP 15
  84 TRUE
  85 The
  86 .I DPMSQueryExtension
  87 function returns TRUE if the extension is available,
  88 and
  89 .I event_base
  90 and
  91 .I error_base
  92 are set to the base event number and base error number for the extension,
  93 respectively.
  94 .TP 15
  95 FALSE
  96 The
  97 .I DPMSQueryExtension
  98 function returns FALSE if extension is not available, and the values of
  99 .I event_base
 100 and
 101 .I error_base
 102 are undefined.
 103 .SH "SEE ALSO"
 104 .BR DPMSGetVersion (__libmansuffix__)