DPMSInfo(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


DPMSInfo(3)                                      X FUNCTIONS                                     DPMSInfo(3)



NAME
       DPMSInfo - returns information about the current DPMS state

SYNOPSIS
       cc [ flag ... ] file ... -lXext [ library ... ]
       #include <X11/extensions/dpms.h>

       Status DPMSInfo
              (
                    Display *display,
                    CARD16 *power_level,
                    BOOL *state
              );

ARGUMENTS
       display
              Specifies the connection to the X server

       power_level
              Specifies the current power level

       state  Specifies the current DPMS state

DESCRIPTION
       The DPMSInfo function returns information about the current Display Power Management Signaling (DPMS)
       state. The state return parameter indicates whether  or  not  DPMS  is  enabled  (TRUE)  or  disabled
       (FALSE).  The  power_level  return  parameter  indicates  the current power level (one of DPMSModeOn,
       DPMSModeStandby, DPMSModeSuspend, or DPMSModeOff.)

RETURN VALUES
       TRUE           The DPMSInfo function returns TRUE, if values are returned.

       FALSE          The DPMSInfo function returns FALSE, if no values are returned.

SEE ALSO
       DPMSEnable(3)



X Version 11                                    libXext 1.0.5                                    DPMSInfo(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?