SIFWorks ADK 2.0
Initialize Method (version, sdoLibraries)
NamespacesEdustructures.SifWorksAdkInitialize(SifVersion, SdoLibraryType)

[This is preliminary documentation and is subject to change.]

Initialize the Adk to use the specified version of SIF. Calling this method when the Adk has already been initialized has no effect. This method must be called at agent startup to initialize various resources of the Adk, establish global settings for the class framework, and set the default version of SIF to which all messages originating from the agent will conform. Beginning with Adk 1.5.0, this method also configures the global Adk ServerLog instance with a logging module that will be inherited by the ServerLog of all zones. It installs a single logging module implementation: DefaultServerLogModule. The behavior of this module is to report SIF_LogEntry objects to the zone integration server via an Add SIF_Event message whenever ServerLog.reportLogEntry is called on a zone and the agent is running in SIF 1.5 or later. DefaultServerLogModule also echos server log messages to the zone's local logging framework Category so that agents do not need to duplicate logging to both the server and local agent log. If you want to install a custom ServerLogModule implementation -- or need to adjust the settings of the default module installed when the Adk is initialized -- call the Adk.getServerLog method to obtain a reference to the root of the ServerLog chain, then call its methods to add and remove modules. Refer to the ServerLog class for more information on server logging.
Declaration Syntax
C#Visual BasicVisual C++
public static void Initialize(
	SifVersion version,
	SdoLibraryType sdoLibraries
)
Public Shared Sub Initialize ( _
	version As SifVersion, _
	sdoLibraries As SdoLibraryType _
)
public:
static void Initialize (
	SifVersion^ version, 
	SdoLibraryType sdoLibraries
)
Parameters
version (SifVersion)
The version of SIF that will be used by the agent this session. Supported versions are enumerated by constants of the SifVersion class. Once initialized, the version cannot be changed.
sdoLibraries (SdoLibraryType)
One or more of the constants defined by the SdoLibrary class, identifying the SIF Data Object libraries to be loaded into memory (e.g. SdoLibraryType.STUDENT | SdoLibraryType.HR )
Exceptions
ExceptionCondition
AdkNotSupportedException AdkNotSupportedException is thrown if the specified SIF version is not supported by the Adk, or if the sdoLibraries parameter is invalid

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10