man/DPMSGetVersion.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 DPMSGetVersion __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSGetVersion \- returns the version of the DPMS extension implemented by
  37 the X server
  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 Status DPMSGetVersion
  45 (
  46 .br
  47       Display *\fIdisplay\fP\^,
  48 .br
  49       int *\fImajor_version\fP\^,
  50 .br
  51       int *\fIminor_version\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 major_version
  61 Specifies the return location for the extension major version
  62 .TP
  63 .I minor_version
  64 Specifies the return location for the extension minor version
  65 .SH DESCRIPTION
  66 .LP
  67 The
  68 .I DPMSGetVersion
  69 function returns the version of the Display Power Management Signaling (DPMS)
  70 extension implemented by the X server.  It returns a major and minor version
  71 number. The major version number will be incremented for protocol incompatible
  72 changes, and the minor version number will be incremented for small, upward
  73 compatible changes.
  74 .SH "RETURN VALUES"
  75 .TP 15
  76 TRUE
  77 The
  78 .I DPMSGetVersion
  79 function returns TRUE when the extension is supported and values are returned.
  80 .TP 15
  81 FALSE
  82 The
  83 .I DPMSGetVersion
  84 function returns FALSE when the extension is not supported.
  85 .SH "SEE ALSO"
  86 .BR DPMSCapable (__libmansuffix__),
  87 .BR DPMSQueryExtension (__libmansuffix__)