hyperx.api.Environment Class Reference

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

Inheritance diagram for hyperx.api.Environment:

Public Member Functions
str	ApiVersion (self)
	The scripting API version of this HyperX environment.
str	InstallLocation (self)

Static Public Member Functions
None	Initialize ()
	Initialize the HyperX scripting environment.
bool	IsApiVersionAvailable (int major, int minor, int build)
bool	IsApiVersionAvailable (item1=None, item2=None, item3=None)
bool	IsApiVersionAvailable (str version)
None	SetLocation (str location)
	Set the directory location of the HyperX binaries.

Detailed Description

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

Member Function Documentation

ApiVersion()

str hyperx.api.Environment.ApiVersion

(

self

)

The scripting API version of this HyperX environment.

Initialize()

None hyperx.api.Environment.Initialize ( )

static

Initialize the HyperX scripting environment.

InstallLocation()

str hyperx.api.Environment.InstallLocation

(

self

)

IsApiVersionAvailable() [1/3]

bool hyperx.api.Environment.IsApiVersionAvailable ( int major, int minor, int build )

static

IsApiVersionAvailable() [2/3]

bool hyperx.api.Environment.IsApiVersionAvailable ( item1 = None, item2 = None, item3 = None )

static

IsApiVersionAvailable() [3/3]

bool hyperx.api.Environment.IsApiVersionAvailable ( str version )

static

SetLocation()

None hyperx.api.Environment.SetLocation ( str 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.

---

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

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py