This manual page is for Mac OS X version 10.6

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.


DPMSForceLevel(3)                                X FUNCTIONS                               DPMSForceLevel(3)



NAME
       DPMSForceLevel - forces a DPMS capable display into the specified power level

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

       Status DPMSForceLevel ( Display *display, CARD16 level );

ARGUMENTS
       display
              Specifies the connection to the X server

       level  Specifies the level to force power to

DESCRIPTION
       The  DPMSForceLevel function forces a DPMS capable display into the specified power level.  The level
       must be one of following four states: DPMSModeOn, DPMSModeStandby, DPMSModeSuspend,  or  DPMSModeOff.
       Values  other than these will result in a BadValue error.  If DPMS is disabled on the display, trying
       to set the power level on the display will result in a BadMatch protocol error.

RETURN VALUES
       TRUE           The DPMSForceLevel function always returns TRUE.

ERRORS
       BadValue       A level other than DPMSModeOn, DPMSModeStandby, DPMSModeSuspend,  or  DPMSModeOff  was
                      specified.

       BadMatch       DPMS is disabled on the specified display.

SEE ALSO
       DPMSCapable(3), DPMSInfo(3), DPMSGetTimeouts(3), DPMSSetTimeouts(3)



X Version 11                                    libXext 1.0.5                              DPMSForceLevel(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.