Deadline Scripting Reference  10.1.23.6
Deadline.Scripting.SystemUtils Class Reference

System utility functions. More...

Static Public Member Functions

static long GetAvailableRam ()
 Gets the system's available memory. More...
 
static int GetCpuCount ()
 Gets the system's CPU count. More...
 
static string GetRegistryKeyValue (string keyName, string valueName, string defaultValue)
 Gets a value from the system's registry (Windows only). More...
 
static long GetTotalRam ()
 Gets the system's total memory. More...
 
static long GetUsedRam ()
 Gets the system's memory that is currently in use. More...
 
static bool Is64Bit ()
 Checks if the system is 64 bit. More...
 
static bool IsRunningOnLinux ()
 Checks if the system is Linux. More...
 
static bool IsRunningOnMac ()
 Checks if the system is Mac OSX. More...
 
static bool IsRunningOnWindows ()
 Checks if the system is Windows. More...
 
static void Sleep (int milliseconds)
 Sleep for the specified time. More...
 

Detailed Description

System utility functions.

Member Function Documentation

◆ GetAvailableRam()

static long Deadline.Scripting.SystemUtils.GetAvailableRam ( )
static

Gets the system's available memory.

Returns
The memory in bytes.

◆ GetCpuCount()

static int Deadline.Scripting.SystemUtils.GetCpuCount ( )
static

Gets the system's CPU count.

Returns
The number of CPUs.

◆ GetRegistryKeyValue()

static string Deadline.Scripting.SystemUtils.GetRegistryKeyValue ( string  keyName,
string  valueName,
string  defaultValue 
)
static

Gets a value from the system's registry (Windows only).

Parameters
keyNameThe registry key name.
valueNameThe value name.
defaultValueThe default value if the key or value doesn't exist.
Returns
The result.

◆ GetTotalRam()

static long Deadline.Scripting.SystemUtils.GetTotalRam ( )
static

Gets the system's total memory.

Returns
The memory in bytes.

◆ GetUsedRam()

static long Deadline.Scripting.SystemUtils.GetUsedRam ( )
static

Gets the system's memory that is currently in use.

Returns
The memory in bytes.

◆ Is64Bit()

static bool Deadline.Scripting.SystemUtils.Is64Bit ( )
static

Checks if the system is 64 bit.

Returns
True if it is 64 bit.

◆ IsRunningOnLinux()

static bool Deadline.Scripting.SystemUtils.IsRunningOnLinux ( )
static

Checks if the system is Linux.

Returns
True if it is Linux.

◆ IsRunningOnMac()

static bool Deadline.Scripting.SystemUtils.IsRunningOnMac ( )
static

Checks if the system is Mac OSX.

Returns
True if it is Mac OSX.

◆ IsRunningOnWindows()

static bool Deadline.Scripting.SystemUtils.IsRunningOnWindows ( )
static

Checks if the system is Windows.

Returns
True if it is Windows.

◆ Sleep()

static void Deadline.Scripting.SystemUtils.Sleep ( int  milliseconds)
static

Sleep for the specified time.

Parameters
millisecondsThe time to sleep, in milliseconds.