HyperX.Scripting.Environment Class Reference

Represents HyperX's execution environment (where HyperX is installed). More...

Static Public Member Functions
static void	Initialize ()
	Initialize the HyperX scripting environment.
static bool	IsApiVersionAvailable (int major, int minor, int build)
static bool	IsApiVersionAvailable (string version)
static void	SetLocation (string location)
	Set the directory location of the HyperX binaries.

Properties
static string	ApiVersion [get]
	The scripting API version of this HyperX environment.
static string	InstallLocation [get]

Detailed Description

Represents HyperX's execution environment (where HyperX is installed).

Member Function Documentation

Initialize()

void HyperX.Scripting.Environment.Initialize ( )

static

Initialize the HyperX scripting environment.

IsApiVersionAvailable() [1/2]

bool HyperX.Scripting.Environment.IsApiVersionAvailable ( int major, int minor, int build )

static

IsApiVersionAvailable() [2/2]

bool HyperX.Scripting.Environment.IsApiVersionAvailable ( string version )

static

SetLocation()

void HyperX.Scripting.Environment.SetLocation ( string location )

static

Set the directory location of the HyperX binaries.

• This method is not required for Python and IronPython client application.
• This method is required for C# and VB.NET clients as these applications need HyperX.Scripting.dll alongside its binaries.

Parameters

location

Path to the binaries.

Property Documentation

ApiVersion

string HyperX.Scripting.Environment.ApiVersion

staticget

The scripting API version of this HyperX environment.

InstallLocation

string HyperX.Scripting.Environment.InstallLocation

staticget

---

The documentation for this class was generated from the following file:

• Environment.cs