DisplayRequired property

  • Article

The DisplayRequired property specifies whether the display is available from now on.

This property is write-only.

Syntax

HRESULT put_DisplayRequired(
  [in]  VARIANT_BOOL newVal
);

Property value

A new value that specifies whether the system display is to be available. If set to VARIANT_TRUE, the system requires that the display remains available and fully powered until the property is set to VARIANT_FALSE.

Error codes

DisplayRequired returns a standard HRESULT.

Remarks

If the DisplayRequired property is set to VARIANT_TRUE, the Console interface uses the SetThreadExecutionState or PowerSetRequest API to keep the display powered on until the property is set to VARIANT_FALSE. For more information about these APIs, see the Windows Software Development Kit (SDK) documentation.

See also

Console

 

 

Send comments about this topic to Microsoft

Build date: 1/12/2012