Class Power

View Source

Definition

Namespace:
Tizen.System
Assembly:
Tizen.System.dll

The Power class provides methods to control the power service.


                
C#

                

                    
Copy

                    

                

            
public static class Power
Inheritance
object
Power
Remarks

The Power API provides the way to control the power service. It can be made to hold the specific state to avoid the CPU state internally.

Methods

View Source

ReleaseCpuLock()

[Obsolete("Please do not use! this will be deprecated")]

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("Please do not use! This will be deprecated! Please use ReleaseLock instead!")]
public static void ReleaseCpuLock()
Remarks

The Power API provides the way to control the power service. It can be made to hold the specific state to avoid the CPU state internally.

Exceptions
Type Condition
System.UnauthorizedAccessException

If the privilege is not set.
System.InvalidOperationException

In case of any system error.
View Source

ReleaseLock(PowerLock)

Releases the lock state.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void ReleaseLock(PowerLock type)
Parameters
Type Name Description
PowerLock type

The power type to request lock.
Remarks

The Power API provides the way to control the power service. It can be made to hold the specific state to avoid the CPU state internally.

Examples

                

                

                    
Copy

                    

                

            
Tizen.System.Power.ReleaseLock(Tizen.System.Power.PowerLock.Cpu);
Exceptions
Type Condition
System.ArgumentException

When an invalid parameter value is set.
System.UnauthorizedAccessException

If the privilege is not set.
System.InvalidOperationException

In case of any system error.
View Source

RequestCpuLock(int)

[Obsolete("Please do not use! this will be deprecated")]

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("Please do not use! This will be deprecated! Please use RequestLock instead!")]
public static void RequestCpuLock(int timeout)
Parameters
Type Name Description
int timeout

The positive number in milliseconds or 0 for the permanent lock. So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero.
Remarks

If the process dies, then every lock will be removed.

Exceptions
Type Condition
System.ArgumentException

When an invalid parameter value is set.
System.UnauthorizedAccessException

If the privilege is not set.
System.InvalidOperationException

In case of any system error.
View Source

RequestLock(PowerLock, int)

Locks the given lock state for a specified time. After the given timeout (in milliseconds), unlock the given lock state automatically.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void RequestLock(PowerLock type, int timeout)
Parameters
Type Name Description
PowerLock type

The power type to request lock.
int timeout

The positive number in milliseconds or 0 for the permanent lock. So you must release the permanent lock of the power state with ReleaseLock() if timeout_ms is zero.
Remarks

If the process dies, then every lock will be removed.

Examples

                

                

                    
Copy

                    

                

            
Tizen.System.Power.RequestLock(Tizen.System.Power.PowerLock.Cpu, 2000);
Exceptions
Type Condition
System.ArgumentException

When an invalid parameter value is set.
System.UnauthorizedAccessException

If the privilege is not set.
System.InvalidOperationException

In case of any system error.