DPMSForceLevel (3) Linux Manual Page

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.