|
|
|
DtSearchExit(3) -- Perform orderly shutdown of search engine
|
|
DtSearchExit is an internal exit call for the online API. It may be called by any API module when a fatal error or aborting signal is detected. It performs an orderly shutdown of the search engine including graceful database closure, communications disconnect, release of system resources, restoration of environment, etc., as necessary. It will call a user exit function if one was installed by DtSe... |
|
DtSearchFreeMessages(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
|
DtSearchFreeResults(3) -- Free storage allocated for DtSearch results lists
|
|
The DtFreeSearchResults function frees the results list pointed to by list which was originally returned from DtSearchQuery, and sets the list pointer to NULL. |
|
DtSearchGetKeytypes(3) -- Access the Keytypes array for a DtSearch database
|
|
The DtSearchGetKeytypes function returns a pointer to the keytypes array of the specified database. The caller may modify the is_selected member of any DtSrKeytype but should not alter any other member values. This function may be called anytime after DtSearchInit. |
|
DtSearchGetMaxResults(3) -- Obtain the DtSearch maximum results value
|
|
The results list returned from DtSearchQuery will be truncated to a maximum number of items after search completion and statistical ranking. DtSearchGetMaxResults returns the current maximum results setting. The function can be called any time after DtSearchInit. |
|
DtSearchGetMessages(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
DtSearchHasMessages(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
DtSearchHighlight(3) -- Generate DtSrHitwords table for highlighting DtSearch document
|
|
The DtSearchHighlight function generates an array of offsets and lengths (DtSrHitword) of parsed linguistic terms (stems) in the passed document cleartext to enable a browser to highlight the words in the text as appropriate for its user interface. |
|
DtSearchInit(3) -- Initialize the DtSearch online API for subsequent calls
|
|
DtSearchInit opens databases and other files and initializes the search engine API for subsequent requests. It must be the first online DtSearch function called. DtSearchInit may be called only once, although DtSrReinit may be called at any time after DtSearchInit. If this function fails, the caller should display the MessageList returned and exit; no subsequent requests will be possible. |
|
DtSearchMergeResults(3) -- Merge two DtSearch results lists into one
|
|
DtSearchMergeResults merges the srclist results list into the targlist list using proximity for sort order, and sets the srclist source list pointer to NULL. This function is used to merge results from separate database searches for presentation to the user as a single results list. It presumes both lists are initially sorted by ascending proximity. It does nothing if source list is empty and retu... |
|
DtSearchQuery(3) -- Perform a DtSearch database search for a specified query
|
|
DtSearchQuery is the DtSearch API search function. DtSearchQuery is passed a query string and some search options, performs the requested search, and if successful returns a linked list of DtSrResult structures representing the documents satisfying the search. The results list contains information about the documents that can be used for subsequent retrievals, as well as information suitable for d... |
|
DtSearchReinit(3) -- Reinitialize the DtSearch online API
|
|
DtSearchReinit closes and reopens databases and other files as necessary, and reinitializes the search engine API. It is typically used after either databases or the ocf file have been externally changed to force the search engine to reinitialize itself, and to acquire the new database names if any. It can also be used after any function returns DtSrREINIT to acquire the new database names. |
|
DtSearchRetrieve(3) -- Return clear text of documents from DtSearch databases
|
|
DtSearchRetrieve retrieves the uncompressed document text of a specified DtSearch document listed in the DtSrResult list from a previous call to DtSearchQuery. It will be successful only in an AusText type database where the documents are stored directly in a database repository. |
|
DtSearchSetMaxResults(3) -- Set the DtSearch maximum results value
|
|
The results list returned from DtSearchQuery will be truncated to a maximum number of items after search completion and statistical ranking. DtSearchSetMaxResults changes the maximum results setting to max. If DtSearchSetMaxResults is never called, the maximum number of DtSrResult items returned will default to 20. The function can be called any time after DtSearchInit(). |
|
DtSearchSortResults(3) -- Sort DtSearch results lists
|
|
DtSearchSortResults sorts lists returned from DtSearchQuery. Note that results lists are already presorted by proximity by DtSearchQuery. |
