 | Environment Class |
The Lyncée Tec API environment, required for any work with the APIs
Inheritance HierarchyNamespace: LynceeTec.API
Assembly: LynceeTec.API (in LynceeTec.API.dll) Version: 10.1.23514.0 , built 2023-11-07 12:21:48 UTC
SyntaxThe Environment type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | AvailableMagnifications |
List of available magnifications for the current environment
|
| DatabaseVersion |
The version of the database in use
|
| IsDongleOffline |
Gets a value indicating if an Offline dongle was found at environment start
|
| IsInitialized |
Gets a value indicating whether the Environment is already initialized
|
| IsLoggedIn |
Gets a value indicating whether the Environment is already logged in
|
| IsStarted |
Gets a value indicating whether the Environment is already started
|
| NumberOfWavelengths |
Number of available wavelengths for the current environment
|
Methods| Name | Description | |
|---|---|---|
 | End |
Cleanly ends the Lyncée Tec API session and disposes the resources. One of the overload of Start must have been called first.
|
| Init |
Initializes the environment. Start(String) and Login(String, SecureString) must be called first.
|
| Login |
Login a user. Start(String) must be called first.
|
| Logout |
Logout the current user
|
| Start |
Entry point in the Lyncée Tec APIs. Initializes the environment. Use this version when working with metadata only (no database).
|
| Start(String) |
Entry point in the Lyncée Tec APIs. Starts the environment. Use this version when working with a Koala database. To be ready to use the environment, call
Login(String, SecureString) and Init afterwards
|
| StartAndInit |
Entry point in the Lyncée Tec APIs. Starts the environment, logs in and initializes the environment. Use this version when working with a Koala database for special applications
which do never switch Koala user.
|
See Also