CreateProject Method

In This Topic

Create a new HpD project.

Syntax

public string CreateProject( 
   string name,
   string location,
   string defaultLibraryConnection,
   List<string> variants
)

Parameters

name: Name of the project.
location: Location of the new project directory.
defaultLibraryConnection: Path to connection file.
variants: List of variant names for the new project. If not supplied just the single default 'Variant_1' is created.

Return Value

Path to the created project.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from Status property. If API is uninitialized, you can initialize it by calling Init(String,String[]) method. If API is in failed state, you can not resurrect it.
EPLAN.Harness.API.Exceptions.ArgumentException	Argument is invalid. The exception is thrown when a wrong argument is passed to the method or the setter of property.
EPLAN.Harness.API.Exceptions.DirectoryNotFoundException	This directory was not found.
EPLAN.Harness.API.Exceptions.FileExtensionException	The exception that is thrown when the file has the wrong extension.
EPLAN.Harness.API.Exceptions.FileNotFoundException	This file was not found.
EPLAN.Harness.API.Exceptions.OperationFailedException	Project was not created.

Remarks

The new project may or may not have default library connection.
The new project will have just one default variant with name 'Variant_1' unless the variants parameter is passed.

Example

This example shows how to create a new simple project.

// API is already initialized.
HpdApi api = HpdApi.GetInstance();

string newProjectPath = api.CreateProject("NewProjectName", @"Path to directory where the project will be saved.");

// Project "NewProjectName" is created. Path to the new project is returned.
// You can open the project using:
api.OpenProject(newProjectPath);

This example shows how to create a new project with default project library.

// API is already initialized.
HpdApi api = HpdApi.GetInstance();

string libraryConnection = @"Path to a connection file (*.hxcn)";

string newProjectPath = api.CreateProject("NewProjectName", @"Location...", libraryConnection);

Reference

HpdApi Class
HpdApi Members
Init(String,String[]) Method
GetInstance Method
OpenProject Method

Send Feedback