dtSearch Text Retrieval Engine Programmer's Reference
Server Object - Deprecated Members

In previous versions of the dtSearch Engine, the Server object had to be initialized through a call to the Initialize method before any other functions could be used. Initialization is no longer necessary and is deprecated in version 6. Instead, use the Options object to set or change dtSearch Engine settings as needed. The following methods and properties associated with the obsolete initialization process are also deprecated: DebugLogName, HomeDir, PrivateDir, Initialized, InitMessage, MessageHandler, SendTestInfo, SendTestMessage, SendTestQuestion, LZWEnableCode, Showdown. These methods and properties are documented at the end of this below. 

Obsolete Methods and Properties 

These methods and properties continue to function to preserve backward compatibility but are now deprecated. Initialization of the dtSearch Engine is no longer needed, and the Options object provides access to all configurable settings such as the PrivateDir. 

DebugLogName as String [use SetDebugLogging instead] 

Name of the debugging log file where the engine will record a detailed log of its actions. If blank, no log will be created. 

HomeDir as String [Use Options object instead] 

The path to the data files used by the engine. This can be a shared directory on networks. The engine only requires read access to this directory. If blank, the engine will use the directory where dten600.dll is located. If you are indexing database files using ODBC, dtv_odbc.dll must be located in a subdirectory named "Viewers" of the HomeDir. For more information, see "Initialization and the Home and Private Directories". 

Initialized as Integer [read-only] [Initialization is no longer needed] 

True if the engine was successfully initialized. 

InitMessage as String [read-only] [Initialization is no longer needed] 

Text string describing the initialization status of the engine. If initialization did not succeed, this InitMessage will contain an error message. 

MessageHandler as Object [Use the Errors object instead] 

The MessageHandler is an object that will receive error messages, information messages, and questions sent by the engine. In a Visual Basic program, the MessageHandler can be any object or form that has the following three methods: 

Public Sub ReceiveErrorMessage(ByVal msg As String) 

Public Sub ReceiveInfoMessage(ByVal msg As String) 

Public Function ReceiveQuestion(ByVal msg As String) As Integer 

This property is optional. If not provided, all messages will be logged to the debug log file (if one was specified) and all questions will be implicitly answered "Yes". ReceiveQuestion should return 0 for "No" and 1 for "Yes". 

PrivateDir as String [Use the Options object instead] 

Each instance of the engine needs a separate private directory to use for temporary files. The PrivateDir is also the place that the engine will check first to locate setup files. For setup files that are not found in the PrivateDir, the engine will check in the HomeDir. 

SendTestError as Boolean 

SendTestInfo as Boolean 

SendTestQuestion as Boolean 

These flags are for testing the object provided as the MessageHandler. If the flags are true, the engine will send a test error message, information message, or question to the MessageHandler upon initialization. 

LzwEnableCode as Long [Obsolete] 

In older versions of the dtSearch Engine, due to patent issues associated with LZW decompression, LZW decompression in the dtSearch Engine was locked with an access code. The relevant patent is now expired. 


Initialize() as Integer 

Attempts to initialize the dtSearch engine based on the supplied PrivateDir, HomeDir, and MessageHandler. If a DebugLogName was provided, a debugging log of the initialization process will be recorded. 

Shutdown() as Integer 

Shuts down the dtSearch engine.