man/DPMSInfo.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 DPMSInfo __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSInfo \- returns information about the current DPMS state
  37 .SH SYNOPSIS
  38 .PP
  39 .nf
  40 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  41 \&#include <X11/extensions/dpms.h>
  42 .HP
  43 .B Status DPMSInfo
  44 (
  45 .br
  46       Display \fI*display\fP\^,
  47 .br
  48       CARD16 \fI*power_level\fP\^,
  49 .br
  50       BOOL \fI*state\fP\^
  51 );
  52 .if n .ti +5n
  53 .if t .ti +.5i
  54 .SH ARGUMENTS
  55 .TP
  56 .I display
  57 Specifies the connection to the X server
  58 .TP
  59 .I power_level
  60 Specifies the current power level
  61 .TP
  62 .I state
  63 Specifies the current DPMS state
  64 .SH DESCRIPTION
  65 .LP
  66 The
  67 .I DPMSInfo
  68 function returns information about the current Display Power Management
  69 Signaling (DPMS) state. The \fIstate\fP
  70 return parameter indicates whether or not DPMS is enabled \^(TRUE\^) or
  71 disabled \^(FALSE\^). The \fIpower_level\fP return parameter indicates the
  72 current power level \^(one of DPMSModeOn, DPMSModeStandby, DPMSModeSuspend, or
  73 DPMSModeOff.\^)
  74 .SH "RETURN VALUES"
  75 .TP 15
  76 TRUE
  77 The
  78 .I DPMSInfo
  79 function returns TRUE, if values are returned.
  80 .TP 15
  81 FALSE
  82 The
  83 .I DPMSInfo
  84 function returns FALSE, if no values are returned.
  85 .SH "SEE ALSO"
  86 .BR DPMSEnable (__libmansuffix__)