SystemRequired property

The SystemRequired property specifies whether the computer is available from now on.

This property is write-only.

Syntax

HRESULT put_SystemRequired(
  [in]  VARIANT_BOOL newVal
);

Property value

A new value that specifies whether the computer is to be available. If set to VARIANT_TRUE, the system is prevented from transitioning into a sleep or hibernate power state until the property is set to VARIANT_FALSE.

Error codes

SystemRequired returns a standard HRESULT.

Remarks

If the SystemRequired 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