man-pages/man3/DPMSGetTimeouts.3.html
2021-03-31 01:06:50 +01:00

122 lines
2.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of DPMSGetTimeouts</TITLE>
</HEAD><BODY>
<H1>DPMSGetTimeouts</H1>
Section: X FUNCTIONS (3)<BR>Updated: libXext 1.3.4<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
DPMSGetTimeouts - retrieves the timeout values used by the X server for DPMS
timings
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<PRE>
<B>cc</B> [ <I>flag</I> ... ] <I>file</I> ... -<B>lXext</B> [ <I>library</I> ... ]
#include &lt;<A HREF="file:///usr/include/X11/extensions/dpms.h">X11/extensions/dpms.h</A>&gt;
<DL COMPACT>
<DT id="1"><B>Bool DPMSGetTimeouts</B>
(
<DD> Display *<I>display</I>,
<DD> CARD16 *<I>standby</I>,
<DD> CARD16 *<I>suspend</I>,
<DD> CARD16 *<I>off</I>
);
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</DL>
</PRE><A NAME="lbAD">&nbsp;</A>
<H2>ARGUMENTS</H2>
<DL COMPACT>
<DT id="2"><I>display</I>
<DD>
<DD>Specifies the connection to the X server
<DT id="3"><I>standby</I>
<DD>
Specifies the current standby timeout in seconds
<DT id="4"><I>suspend</I>
<DD>
Specifies the current suspend timeout in seconds
<DT id="5"><I>off</I>
<DD>
Specifies the current off timeout in seconds
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
The
<I>DPMSGetTimeouts</I>
function retrieves the timeout values used by the X server for DPMS timings.
<P>
The value
<I>standby</I>
is the amount of time of inactivity in seconds before standby mode is invoked. A
value of zero indicates that this mode has been disabled.
<P>
The value <I>suspend</I> is the amount of time of inactivity in seconds before
the second level of power savings is invoked. A value of zero indicates that
this mode has been disabled.
<P>
The value <I>off</I> is the amount of time of inactivity in seconds before the
third and final level of power savings is invoked. A value of zero indicates
that this mode has been disabled.
<A NAME="lbAF">&nbsp;</A>
<H2>RETURN VALUES</H2>
<DL COMPACT>
<DT id="6">TRUE<DD>
The
<I>DPMSGetTimeouts</I>
function returns TRUE when values are returned.
<DT id="7">FALSE<DD>
The
<I>DPMSGetTimeouts</I>
function returns FALSE when no values returned.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+DPMSCapable">DPMSCapable</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+DPMSInfo">DPMSInfo</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+DPMSSetTimeouts">DPMSSetTimeouts</A></B>(3)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="10"><A HREF="#lbAD">ARGUMENTS</A><DD>
<DT id="11"><A HREF="#lbAE">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAF">RETURN VALUES</A><DD>
<DT id="13"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:39 GMT, March 31, 2021
</BODY>
</HTML>