Click or drag to resize

EnvironmentStart Method (String, SecureString, String)

Entry point in the Lyncée Tec APIs. Initializes the environment. Use this version when working with a Koala database.

Namespace:  LynceeTec.API
Assembly:  LynceeTec.API (in LynceeTec.API.dll) Version: 9.0.26418.0 , built 2021-10-22 08:54:12 UTC
Syntax
Copy
public static IConfigManager Start(
	string userName,
	SecureString password,
	string databasePath
)

Parameters

userName
Type: SystemString
The name of the user to log in at start-up.
password
Type: System.SecuritySecureString
The password of the user to log in at start-up
databasePath
Type: SystemString
The full path to the database

Return Value

Type: IConfigManager
The instance of the configuration manager. Mainly needed for the initialization of other APIs and to retrieve additional values. (Note that this is the legacy IConfigManager as used in the old Koala. Future versions of the API will return the new manager, more adapted to the new core).
Exceptions
ExceptionCondition
EnvironmentAlreadyStartedExceptionThrown if the environment was already initialized because Start was already called before.
Remarks
A database is needed when working with hardware (for example for live images acquisitions and holograms recording).
See Also