man/DPMSGetTimeouts.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 DPMSGetTimeouts __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSGetTimeouts \- retrieves the timeout values used by the X server for DPMS
  37 timings
  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 DPMSGetTimeouts
  45 (
  46 .br
  47       Display *\fIdisplay\fP\^,
  48 .br
  49       CARD16 *\fIstandby\fP\^,
  50 .br
  51       CARD16 *\fIsuspend\fP\^,
  52 .br
  53       CARD16 *\fIoff\fP\^
  54 );
  55 .if n .ti +5n
  56 .if t .ti +.5i
  57 .SH ARGUMENTS
  58 .TP
  59 .I display
  60 Specifies the connection to the X server
  61 .TP
  62 .I standby
  63 Specifies the current standby timeout in seconds
  64 .TP
  65 .I suspend
  66 Specifies the current suspend timeout in seconds
  67 .TP
  68 .I off
  69 Specifies the current off timeout in seconds
  70 .SH DESCRIPTION
  71 .LP
  72 The
  73 .I DPMSGetTimeouts
  74 function retrieves the timeout values used by the X server for DPMS timings.
  75 .LP
  76 The value
  77 .I standby
  78 is the amount of time of inactivity in seconds before standby mode is invoked. A
  79 value of zero indicates that this mode has been disabled.
  80 .LP
  81 The value \fIsuspend\fP is the amount of time of inactivity in seconds before
  82 the second level of power savings is invoked.  A value of zero indicates that
  83 this mode has been disabled.
  84 .LP
  85 The value \fIoff\fP is the amount of time of inactivity in seconds before the
  86 third and final level of power savings is invoked. A value of zero indicates
  87 that this mode has been disabled.
  88 .SH "RETURN VALUES"
  89 .TP 15
  90 TRUE
  91 The
  92 .I DPMSGetTimeouts
  93 function returns TRUE when values are returned.
  94 .TP 15
  95 FALSE
  96 The
  97 .I DPMSGetTimeouts
  98 function returns FALSE when no values returned.
  99 .SH "SEE ALSO"
 100 .BR DPMSCapable (__libmansuffix__),
 101 .BR DPMSInfo (__libmansuffix__),
 102 .BR DPMSSetTimeouts (__libmansuffix__)