hyperx.api.Environment Class Reference

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

Inheritance diagram for hyperx.api.Environment:

Public Member Functions
	__init__ (self, _api.Environment environment)
None	Initialize ()
	Initialize the HyperX scripting environment.
None	SetLocation (str location)
	Set the directory location of the HyperX binaries.

Protected Attributes
	_Entity = environment

Properties
	InstallLocation = property

Detailed Description

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

Constructor & Destructor Documentation

__init__()

hyperx.api.Environment.__init__	(		self,
		_api.Environment	environment )

Member Function Documentation

Initialize()

None hyperx.api.Environment.Initialize

(

)

Initialize the HyperX scripting environment.

SetLocation()

None hyperx.api.Environment.SetLocation

(

str

location

)

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.

Member Data Documentation

_Entity

hyperx.api.Environment._Entity = environment

protected

Property Documentation

InstallLocation

hyperx.api.Environment.InstallLocation = property

static

---

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

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