Environment

Overview

Environment helper class.

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Platforms: .NET, .NET Standard 2.0, Cooper, Island, Toffee, ToffeeV2

 

ApplicationContext

Application context in an Android application. The application should set this before doing anything that requires the context to be set.

 

class property ApplicationContext: ApplicationContext read write;

 

class ApplicationContext ApplicationContext { get; set; }

 

static var ApplicationContext: ApplicationContext { get{} set{} }

 

class ApplicationContext ApplicationContext { __get; __set; }

 

Shared Property ApplicationContext() As ApplicationContext

Architecture

 

class property Architecture: String read;

 

class String Architecture { get; }

 

static var Architecture: String { get{} }

 

class String Architecture { __get; }

 

Shared ReadOnly Property Architecture() As String

CurrentDirectory

Returns the directory that's currently active for this process.

 

class property CurrentDirectory: String read;

 

class String CurrentDirectory { get; }

 

static var CurrentDirectory: String { get{} }

 

class String CurrentDirectory { __get; }

 

Shared ReadOnly Property CurrentDirectory() As String

DesktopFolder

Returns the path to the desktop folder

 

class property DesktopFolder: nullable Folder read;

 

class Folder? DesktopFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var DesktopFolder: Folder? { get{} }
// Toffee
static var DesktopFolder: Folder { get{} }

 

class Folder DesktopFolder { __get; }

 

Shared ReadOnly Property DesktopFolder() As Folder?

EnvironmentVariable Cooper

 

class property EnvironmentVariable[aName: String]: String read;

 

class String EnvironmentVariable[String aName] { get; }

 

static subscript EnvironmentVariable(_ aName: String) -> String { get{} }

 

class String EnvironmentVariable[String aName] { __get; }

 

Shared ReadOnly Property EnvironmentVariable(aName As String) As String

EnvironmentVariable .NET, .NET Standard 2.0, Island, Toffee, ToffeeV2

Access an environment variable by name.

 

class property EnvironmentVariable[aName: String]: String read write;

 

class String EnvironmentVariable[String aName] { get; set; }

 

static subscript EnvironmentVariable(_ aName: String) -> String { get{} set{} }

 

Shared Property EnvironmentVariable(aName As String) As String

FullUserName

Returns the full name of the current user.

 

class property FullUserName: String read;

 

class String FullUserName { get; }

 

static var FullUserName: String { get{} }

 

class String FullUserName { __get; }

 

Shared ReadOnly Property FullUserName() As String

IsMono

True if running on Mono

 

class property IsMono: Boolean read;

 

class Boolean IsMono { get; }

 

static var IsMono: Boolean { get{} }

 

class Boolean IsMono { __get; }

 

Shared ReadOnly Property IsMono() As Boolean

IsRosetta2

 

class property IsRosetta2: nullable Boolean read;

 

class Boolean? IsRosetta2 { get; }

 

static var IsRosetta2: Boolean! { get{} }

 

class Boolean IsRosetta2 { __get; }

 

Shared ReadOnly Property IsRosetta2() As Boolean?

IsWow64Process

 

class property IsWow64Process: Boolean read;

 

class Boolean IsWow64Process { get; }

 

static var IsWow64Process: Boolean { get{} }

 

class Boolean IsWow64Process { __get; }

 

Shared ReadOnly Property IsWow64Process() As Boolean

LineBreak

Gets the linebreak character for this OS. Generally #13#10 on Windows and #10 elswhere.

 

class property LineBreak: String read;

 

class String LineBreak { get; }

 

static var LineBreak: String { get{} }

 

class String LineBreak { __get; }

 

Shared ReadOnly Property LineBreak() As String

MachineName

Returns the name of this machine.

 

class property MachineName: String read;

 

class String MachineName { get; }

 

static var MachineName: String { get{} }

 

class String MachineName { __get; }

 

Shared ReadOnly Property MachineName() As String

OS

Gets the OS type. Use this to determine what the current OS type is.

 

class property OS: OperatingSystem read;

 

class OperatingSystem OS { get; }

 

static var OS: OperatingSystem { get{} }

 

class OperatingSystem OS { __get; }

 

Shared ReadOnly Property OS() As OperatingSystem

OSArchitecture

 

class property OSArchitecture: String read;

 

class String OSArchitecture { get; }

 

static var OSArchitecture: String { get{} }

 

class String OSArchitecture { __get; }

 

Shared ReadOnly Property OSArchitecture() As String

OSBitness

Returns the bitsize of this OS. Generally 32 or 64.

 

class property OSBitness: Int32 read;

 

class Int32 OSBitness { get; }

 

static var OSBitness: Int32 { get{} }

 

class Integer OSBitness { __get; }

 

Shared ReadOnly Property OSBitness() As Int32

OSName

Returns a string representation of this OS name.

 

class property OSName: String read;

 

class String OSName { get; }

 

static var OSName: String { get{} }

 

class String OSName { __get; }

 

Shared ReadOnly Property OSName() As String

OSVersion

Returns the string version.

 

class property OSVersion: String read;

 

class String OSVersion { get; }

 

static var OSVersion: String { get{} }

 

class String OSVersion { __get; }

 

Shared ReadOnly Property OSVersion() As String

ProcessArchitecture

 

class property ProcessArchitecture: String read;

 

class String ProcessArchitecture { get; }

 

static var ProcessArchitecture: String { get{} }

 

class String ProcessArchitecture { __get; }

 

Shared ReadOnly Property ProcessArchitecture() As String

ProcessBitness

Returns the bitsize of this process. Generally 32 or 64.

 

class property ProcessBitness: Int32 read;

 

class Int32 ProcessBitness { get; }

 

static var ProcessBitness: Int32 { get{} }

 

class Integer ProcessBitness { __get; }

 

Shared ReadOnly Property ProcessBitness() As Int32

PROCESSOR_ARCHITECTURE_AMD64 .NET, .NET Standard 2.0

 

const PROCESSOR_ARCHITECTURE_AMD64: Int32 = 9;

 

const Int32 PROCESSOR_ARCHITECTURE_AMD64 = 9

 

static let PROCESSOR_ARCHITECTURE_AMD64: Int32 = 9

 

Dim PROCESSOR_ARCHITECTURE_AMD64 As Int32 = 9

PROCESSOR_ARCHITECTURE_ARM64 .NET, .NET Standard 2.0

 

const PROCESSOR_ARCHITECTURE_ARM64: Int32 = 12;

 

const Int32 PROCESSOR_ARCHITECTURE_ARM64 = 12

 

static let PROCESSOR_ARCHITECTURE_ARM64: Int32 = 12

 

Dim PROCESSOR_ARCHITECTURE_ARM64 As Int32 = 12

PROCESSOR_ARCHITECTURE_INTEL .NET, .NET Standard 2.0

 

const PROCESSOR_ARCHITECTURE_INTEL: Int32 = 0;

 

const Int32 PROCESSOR_ARCHITECTURE_INTEL = 0

 

static let PROCESSOR_ARCHITECTURE_INTEL: Int32 = 0

 

Dim PROCESSOR_ARCHITECTURE_INTEL As Int32 = 0

SystemApplicationSupportFolder

Returns the application support folder for shared files.

 

class property SystemApplicationSupportFolder: nullable Folder read;

 

class Folder? SystemApplicationSupportFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var SystemApplicationSupportFolder: Folder? { get{} }
// Toffee
static var SystemApplicationSupportFolder: Folder { get{} }

 

class Folder SystemApplicationSupportFolder { __get; }

 

Shared ReadOnly Property SystemApplicationSupportFolder() As Folder?

TempFolder

Returns the temporary path

 

class property TempFolder: nullable Folder read;

 

class Folder? TempFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var TempFolder: Folder? { get{} }
// Toffee
static var TempFolder: Folder { get{} }

 

class Folder TempFolder { __get; }

 

Shared ReadOnly Property TempFolder() As Folder?

UserApplicationSupportFolder

Returns the application support folder for user files.

 

class property UserApplicationSupportFolder: nullable Folder read;

 

class Folder? UserApplicationSupportFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserApplicationSupportFolder: Folder? { get{} }
// Toffee
static var UserApplicationSupportFolder: Folder { get{} }

 

class Folder UserApplicationSupportFolder { __get; }

 

Shared ReadOnly Property UserApplicationSupportFolder() As Folder?

UserDownloadsFolder

Returns the downloads folder.

 

class property UserDownloadsFolder: nullable Folder read;

 

class Folder? UserDownloadsFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserDownloadsFolder: Folder? { get{} }
// Toffee
static var UserDownloadsFolder: Folder { get{} }

 

class Folder UserDownloadsFolder { __get; }

 

Shared ReadOnly Property UserDownloadsFolder() As Folder?

UserHomeFolder

Returns the home folder.

 

class property UserHomeFolder: nullable Folder read;

 

class Folder? UserHomeFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserHomeFolder: Folder? { get{} }
// Toffee
static var UserHomeFolder: Folder { get{} }

 

class Folder UserHomeFolder { __get; }

 

Shared ReadOnly Property UserHomeFolder() As Folder?

UserLibraryFolder

Returns the library or appdata folder.

 

class property UserLibraryFolder: nullable Folder read;

 

class Folder? UserLibraryFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserLibraryFolder: Folder? { get{} }
// Toffee
static var UserLibraryFolder: Folder { get{} }

 

class Folder UserLibraryFolder { __get; }

 

Shared ReadOnly Property UserLibraryFolder() As Folder?

UserName

Returns the current username.

 

class property UserName: String read;

 

class String UserName { get; }

 

static var UserName: String { get{} }

 

class String UserName { __get; }

 

Shared ReadOnly Property UserName() As String

 

PROCESSOR_ARCHITECTURE_AMD64 .NET, .NET Standard 2.0

 

const PROCESSOR_ARCHITECTURE_AMD64: Int32 = 9;

 

const Int32 PROCESSOR_ARCHITECTURE_AMD64 = 9

 

static let PROCESSOR_ARCHITECTURE_AMD64: Int32 = 9

 

Dim PROCESSOR_ARCHITECTURE_AMD64 As Int32 = 9

PROCESSOR_ARCHITECTURE_ARM64 .NET, .NET Standard 2.0

 

const PROCESSOR_ARCHITECTURE_ARM64: Int32 = 12;

 

const Int32 PROCESSOR_ARCHITECTURE_ARM64 = 12

 

static let PROCESSOR_ARCHITECTURE_ARM64: Int32 = 12

 

Dim PROCESSOR_ARCHITECTURE_ARM64 As Int32 = 12

PROCESSOR_ARCHITECTURE_INTEL .NET, .NET Standard 2.0

 

const PROCESSOR_ARCHITECTURE_INTEL: Int32 = 0;

 

const Int32 PROCESSOR_ARCHITECTURE_INTEL = 0

 

static let PROCESSOR_ARCHITECTURE_INTEL: Int32 = 0

 

Dim PROCESSOR_ARCHITECTURE_INTEL As Int32 = 0

 

ApplicationContext

Application context in an Android application. The application should set this before doing anything that requires the context to be set.

 

class property ApplicationContext: ApplicationContext read write;

 

class ApplicationContext ApplicationContext { get; set; }

 

static var ApplicationContext: ApplicationContext { get{} set{} }

 

class ApplicationContext ApplicationContext { __get; __set; }

 

Shared Property ApplicationContext() As ApplicationContext

Architecture

 

class property Architecture: String read;

 

class String Architecture { get; }

 

static var Architecture: String { get{} }

 

class String Architecture { __get; }

 

Shared ReadOnly Property Architecture() As String

CurrentDirectory

Returns the directory that's currently active for this process.

 

class property CurrentDirectory: String read;

 

class String CurrentDirectory { get; }

 

static var CurrentDirectory: String { get{} }

 

class String CurrentDirectory { __get; }

 

Shared ReadOnly Property CurrentDirectory() As String

DesktopFolder

Returns the path to the desktop folder

 

class property DesktopFolder: nullable Folder read;

 

class Folder? DesktopFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var DesktopFolder: Folder? { get{} }
// Toffee
static var DesktopFolder: Folder { get{} }

 

class Folder DesktopFolder { __get; }

 

Shared ReadOnly Property DesktopFolder() As Folder?

EnvironmentVariable Cooper

 

class property EnvironmentVariable[aName: String]: String read;

 

class String EnvironmentVariable[String aName] { get; }

 

static subscript EnvironmentVariable(_ aName: String) -> String { get{} }

 

class String EnvironmentVariable[String aName] { __get; }

 

Shared ReadOnly Property EnvironmentVariable(aName As String) As String

EnvironmentVariable .NET, .NET Standard 2.0, Island, Toffee, ToffeeV2

Access an environment variable by name.

 

class property EnvironmentVariable[aName: String]: String read write;

 

class String EnvironmentVariable[String aName] { get; set; }

 

static subscript EnvironmentVariable(_ aName: String) -> String { get{} set{} }

 

Shared Property EnvironmentVariable(aName As String) As String

FullUserName

Returns the full name of the current user.

 

class property FullUserName: String read;

 

class String FullUserName { get; }

 

static var FullUserName: String { get{} }

 

class String FullUserName { __get; }

 

Shared ReadOnly Property FullUserName() As String

IsMono

True if running on Mono

 

class property IsMono: Boolean read;

 

class Boolean IsMono { get; }

 

static var IsMono: Boolean { get{} }

 

class Boolean IsMono { __get; }

 

Shared ReadOnly Property IsMono() As Boolean

IsRosetta2

 

class property IsRosetta2: nullable Boolean read;

 

class Boolean? IsRosetta2 { get; }

 

static var IsRosetta2: Boolean! { get{} }

 

class Boolean IsRosetta2 { __get; }

 

Shared ReadOnly Property IsRosetta2() As Boolean?

IsWow64Process

 

class property IsWow64Process: Boolean read;

 

class Boolean IsWow64Process { get; }

 

static var IsWow64Process: Boolean { get{} }

 

class Boolean IsWow64Process { __get; }

 

Shared ReadOnly Property IsWow64Process() As Boolean

LineBreak

Gets the linebreak character for this OS. Generally #13#10 on Windows and #10 elswhere.

 

class property LineBreak: String read;

 

class String LineBreak { get; }

 

static var LineBreak: String { get{} }

 

class String LineBreak { __get; }

 

Shared ReadOnly Property LineBreak() As String

MachineName

Returns the name of this machine.

 

class property MachineName: String read;

 

class String MachineName { get; }

 

static var MachineName: String { get{} }

 

class String MachineName { __get; }

 

Shared ReadOnly Property MachineName() As String

OS

Gets the OS type. Use this to determine what the current OS type is.

 

class property OS: OperatingSystem read;

 

class OperatingSystem OS { get; }

 

static var OS: OperatingSystem { get{} }

 

class OperatingSystem OS { __get; }

 

Shared ReadOnly Property OS() As OperatingSystem

OSArchitecture

 

class property OSArchitecture: String read;

 

class String OSArchitecture { get; }

 

static var OSArchitecture: String { get{} }

 

class String OSArchitecture { __get; }

 

Shared ReadOnly Property OSArchitecture() As String

OSBitness

Returns the bitsize of this OS. Generally 32 or 64.

 

class property OSBitness: Int32 read;

 

class Int32 OSBitness { get; }

 

static var OSBitness: Int32 { get{} }

 

class Integer OSBitness { __get; }

 

Shared ReadOnly Property OSBitness() As Int32

OSName

Returns a string representation of this OS name.

 

class property OSName: String read;

 

class String OSName { get; }

 

static var OSName: String { get{} }

 

class String OSName { __get; }

 

Shared ReadOnly Property OSName() As String

OSVersion

Returns the string version.

 

class property OSVersion: String read;

 

class String OSVersion { get; }

 

static var OSVersion: String { get{} }

 

class String OSVersion { __get; }

 

Shared ReadOnly Property OSVersion() As String

ProcessArchitecture

 

class property ProcessArchitecture: String read;

 

class String ProcessArchitecture { get; }

 

static var ProcessArchitecture: String { get{} }

 

class String ProcessArchitecture { __get; }

 

Shared ReadOnly Property ProcessArchitecture() As String

ProcessBitness

Returns the bitsize of this process. Generally 32 or 64.

 

class property ProcessBitness: Int32 read;

 

class Int32 ProcessBitness { get; }

 

static var ProcessBitness: Int32 { get{} }

 

class Integer ProcessBitness { __get; }

 

Shared ReadOnly Property ProcessBitness() As Int32

SystemApplicationSupportFolder

Returns the application support folder for shared files.

 

class property SystemApplicationSupportFolder: nullable Folder read;

 

class Folder? SystemApplicationSupportFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var SystemApplicationSupportFolder: Folder? { get{} }
// Toffee
static var SystemApplicationSupportFolder: Folder { get{} }

 

class Folder SystemApplicationSupportFolder { __get; }

 

Shared ReadOnly Property SystemApplicationSupportFolder() As Folder?

TempFolder

Returns the temporary path

 

class property TempFolder: nullable Folder read;

 

class Folder? TempFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var TempFolder: Folder? { get{} }
// Toffee
static var TempFolder: Folder { get{} }

 

class Folder TempFolder { __get; }

 

Shared ReadOnly Property TempFolder() As Folder?

UserApplicationSupportFolder

Returns the application support folder for user files.

 

class property UserApplicationSupportFolder: nullable Folder read;

 

class Folder? UserApplicationSupportFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserApplicationSupportFolder: Folder? { get{} }
// Toffee
static var UserApplicationSupportFolder: Folder { get{} }

 

class Folder UserApplicationSupportFolder { __get; }

 

Shared ReadOnly Property UserApplicationSupportFolder() As Folder?

UserDownloadsFolder

Returns the downloads folder.

 

class property UserDownloadsFolder: nullable Folder read;

 

class Folder? UserDownloadsFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserDownloadsFolder: Folder? { get{} }
// Toffee
static var UserDownloadsFolder: Folder { get{} }

 

class Folder UserDownloadsFolder { __get; }

 

Shared ReadOnly Property UserDownloadsFolder() As Folder?

UserHomeFolder

Returns the home folder.

 

class property UserHomeFolder: nullable Folder read;

 

class Folder? UserHomeFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserHomeFolder: Folder? { get{} }
// Toffee
static var UserHomeFolder: Folder { get{} }

 

class Folder UserHomeFolder { __get; }

 

Shared ReadOnly Property UserHomeFolder() As Folder?

UserLibraryFolder

Returns the library or appdata folder.

 

class property UserLibraryFolder: nullable Folder read;

 

class Folder? UserLibraryFolder { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
static var UserLibraryFolder: Folder? { get{} }
// Toffee
static var UserLibraryFolder: Folder { get{} }

 

class Folder UserLibraryFolder { __get; }

 

Shared ReadOnly Property UserLibraryFolder() As Folder?

UserName

Returns the current username.

 

class property UserName: String read;

 

class String UserName { get; }

 

static var UserName: String { get{} }

 

class String UserName { __get; }

 

Shared ReadOnly Property UserName() As String