Language Reference
Documentation

Language

Objects
Internet Objects

System Object

Has Constructor: NO, Can Create Instance: NO
Can Subclass: NO

System is an intrinsic object use to access information about the user's computer, operating system and other methods related to the bOSL runtime.

Methods

Yield
Syntax: System.Yield

Yield time back to the runtime. Use in the middle of loops to keep you script responsive by allowing the runtime to handle other tasks.

DoEvents
Syntax: System.DoEvents

Same as Yield. Yield time back to the runtime. Use in the middle of loops to keep you script responsive by allowing the runtime to handle other tasks.

GetEnv
Syntax: System.GetEnv(name as string) as string

Returns the value of an Environment Variable.

SetEnv
Syntax: System.SetEnv(name as string, value as string)

Sets the value of a Environment Variable.

Volume
Syntax: System.Volume(VolumeNumber as Integer) as File

Returns a file object that represents a volumen mounted whose number was passed. Volume Zero is the boot volume. Use the property System.VolumeCount to determine the amount of volumes mounted.

Properties

VolumeCount
Data Type: Integer

Returns the number of mounted volumes. Read only.

Ticks
Data Type: Float

Returns the number of ticks (60th of a second) that have passed since the user's computer started. Read only.

Microseconds
Data Type: Float

Returns the number of ticks (1,000,000th of a second) that have passed since the user's computer started. Read only.

UserCancelled
Data Type: Integer

Returns true if the user pressed Commad+Period on MacOS, ESC on Windows and Linux. Use to cancel execution of code. Read only

Desktop
Data Type: File

Returns a file object that represents the user's Desktop folder. Some what funky on Linux. Read only.

Preferences
Data Type: File

Returns a file object that represents the user's Preference folder. In Linux it returns the Home folder. Read only.

Temporary
Data Type: File

Returns a file object that represents the system Temporary folder. Read only.

Sample Code

sub main()
msgbox("Your desktop folder is " & system.desktop.name)

dim minutes as integer
minutes = System.Microseconds/100000/60
msgbox("Your computer has been on for " & minutes & " minutes.")

end sub