Init(String,String[]) Method

In This Topic

Loads HpD and initializes the API. Must be called from the Main Thread of an application.

Syntax

public void Init( 
   string hpdDirectory,
   string[] arguments
)

hpdDirectory: Optionally specify the installation folder of HpD (where the HStudio.exe file is).
arguments: Optionally specify application arguments (that you would otherwise pass to HStudio.exe).

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.HpdApiNotUninitializedException	The API must be in uninitialized state.
EPLAN.Harness.API.Exceptions.HpdLoadError	The HpD could not be loaded.
EPLAN.Harness.API.Exceptions.InternalErrorException	Unexpected error in HpD.
EPLAN.Harness.API.Exceptions.HpdApiVersionException	Installed Harness proD application is not compatible with this version of HpdApi. Check ApiCompatibilityVersion.

Remarks

If no path is specified, the API will try to find the HpD installation folder in registers.

Example

Initialize the API and use it.

HpdApi api = HpdApi.GetInstance();
api.Init();

//Do stuff with API

Send Feedback