Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming


Overview of the API functions

These are the search and browse functions; the first is a search function, the remainder are browse functions:

DesGetSearchResultTable
DesGetBrowseInfo
DesStartBrowseSession
DesOpenDocument
DesGetMatches
DesCloseDocument
DesEndBrowseSession
DesFreeBrowseInfo.
Tip

Many of the API functions need a connection handle (hdbc). You must provide this handle using the SQLConnect function, but this does not prevent you from calling Text Extender from embedded SQL programs. The DB2 Call Level Interface Guide and Reference describes how to mix CLI statements with embedded SQL statements.

You can use the search and browse functions for:

Searching for text

Browsing text.

Searching for text

In this scenario, only the search function DesGetSearchResultTable is needed. It takes as input a search argument and a handle column name. It searches for text and puts information about the documents found into a result table that you have prepared previously.

This function is described in more detail in Searching for text. See also Chapter 15, Sample API program.

Browsing text

Use the following functions in the sequence shown:

Figure 13. Sequence for using the API functions


Sequence for using the API functions

These functions get highlighting information, then start a browse session to display a text document and highlight the found terms.

In a browse session, you can open and display further documents using the same highlighting information. These functions are described in more detail in Browsing text.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]