A Sandcastle Documented Class Library

# IEngine Interface

An object representing an instance of the application engine.

Namespace: Dundas.BI
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public interface IEngine : IServiceContainer,
    	IServiceProvider

    Public Interface IEngine
    	Inherits IServiceContainer, IServiceProvider

    public interface class IEngine : IServiceContainer,
    	IServiceProvider

    type IEngine =
        interface
            interface IServiceContainer
            interface IServiceProvider
        end

The IEngine type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AppDataPath | Gets the physical path to the application's data folder.
| ApplicationStorageEngine | Gets the database engine used for application storage.
| CallerContext | Gets the currently-executing user context.
| Configuration | Gets the currently-loaded application configuration.
| Culture | Gets the culture to use for formatting dates, numbers, etc. This will typically be the culture associated with the in-context Session.
| HostIdentifier | Gets the engine host identifier - a unique name that defines the engine host.
| ServerQualifiedHostIdentifier | Gets the server-qualified engine host identifier.
| Session | Gets the Session associated with the currently-executing user context.
| State | Gets the state of the application engine.
| TempDataPath | Gets the path where any temporary application data is saved.
| TimeZone | Gets the time zone to use for printing dates and times. This will typically be the time zone associated with the in-context Session.

Top
Methods

| Name | Description
--- | --- | ---
| GetService T | Gets the service object of the specified type.
| GetService T (Boolean) | Gets the service object of the specified type.
| SetupException TException | Populates an exception with additional information.
| TryGetCurrentSession | Gets the session associated with the caller.

Top
Events

| Name | Description
--- | --- | ---
| Heartbeat | Occurs when the Engine heartbeat happens - approximately every 60 seconds.
| Initialized | Occurs during engine startup after all registered services implementing IRequireInitialization have been initialized.
| Started | Occurs when the call to StartEngine has completed.
| Stopped | Occurs when a call to ShutdownEngine has completed.
| Stopping | Occurs when the call to ShutdownEngine has started.

Top
Extension Methods

| Name | Description
--- | --- | ---
| Localize(String, Object ) | Overloaded. (Defined by IEngineExtensions.)
| Localize(Type, Object) | Overloaded. (Defined by IEngineExtensions.)
| Localize TEnum (TEnum) | Overloaded. (Defined by IEngineExtensions.)

Top
See Also

#### Reference

Dundas.BI Namespace