Libraries.System.SystemHelper Documentation

This class provides some basic system functions. What it returns is dependent on the implementation of the language.

Example Code

use Libraries.System.SystemHelper

SystemHelper help
output help:GetAvailableProcessors()

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetAvailableProcessors()

This action returns the total number of processors available to the program.

Return

integer: The number of processors currently available to this program.

Example

use Libraries.System.SystemHelper

SystemHelper help
output help:GetAvailableProcessors()

GetFreeMemory()

This action returns the amount of memory that is currently free on the system. How this is computed is implementation dependent.

Return

number: The amount of free memory available.

Example

use Libraries.System.SystemHelper

SystemHelper help
output help:GetFreeMemory()

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetMaximumMemory()

This action returns the maximum amount of memory available on the system.

Return

number: The maximum amount of memory available to the system.

Example

use Libraries.System.SystemHelper

SystemHelper help
output help:GetMaximumMemory()

GetThreadName()

This action returns the name of the thread being actively run on a per system basis.

Return

text: The name of the thread.

Example

use Libraries.System.SystemHelper

SystemHelper help
output help:GetThreadName()

GetTotalMemory()

This action returns the total amount of memory currently on the system.

Return

number: The total amount of memory allocated.

Example

use Libraries.System.SystemHelper

SystemHelper help
output help:GetTotalMemory()

OpenInDefaultTextEditor(Libraries.System.File file)

This action takes the file and opens it in the default text editor on the system, if one exists. If it cannot, it fails silently.

Parameters

RequestGarbageCollection()

This action asks the system to collect any garbage currently in memory. Whether the system honors the request depends on the implementation.

Example

use Libraries.System.SystemHelper

SystemHelper help
output help:RequestGarbageCollection()

Sleep(integer milliseconds)

This class provides some basic system functions. What it returns is dependent on the implementation of the language.

Parameters

  • integer milliseconds: Tells the system to pause for a set number of milliseconds.

Example

use Libraries.System.SystemHelper

SystemHelper help
help:Sleep(1000) //one second