CreateMasterDataLibrary(String,String,String,String,Boolean) Method

In This Topic

Create new EPLAN Platform Master Data (SQL Server) library using SQL authentication.

Syntax

public MasterData2022LibraryConnection CreateMasterDataLibrary( 
   string server,
   string databaseName,
   string userName,
   string password,
   bool rememberPassword
)

Parameters

server: Server name.
databaseName: The name of the database being created.
userName: SQL authentication user name.
password: SQL authentication password.
rememberPassword: Remember the password for future using?

Return Value

Connection to the created EPLAN Platform Master Data library.

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.ArgumentNullException	Argument is null.
EPLAN.Harness.API.Exceptions.OperationFailedException	The operation was not successful.

Remarks

After this method is called the new EPLAN Platform Master Data library is only created, not connected.

If connection is required use the ConnectToLibrary(BaseLibraryConnection,String,String,Boolean) method and pass it the returned library connection.

Example

This example shows how to create new EPLAN Platform Master Data library using SQL authentication.

Library library = Library.GetInstance();

library.CreateMasterDataLibrary("server", "database name", "user name", "password");

This example shows how to create new EPLAN Platform Master Data library using SQL authentication (remember password).

Library library = Library.GetInstance();

library.CreateMasterDataLibrary("server", "database name", "user name", "password", true);

This example shows how to create new EPLAN Platform Master Data library and connect to it.

Library library = Library.GetInstance();

MasterData2022LibraryConnection connection = library.CreateMasterDataLibrary("server", "database name", "user name", "password");
library.ConnectToLibrary(connection, "user name", "password");

Reference

Library Class
Library Members
Overload List

Send Feedback