Purpose
Starts a browse session, establishing the environment needed for browsing a text document and highlighting its matches. It receives a pointer to browse information, either from DesGetBrowseInfo or from DesGetSearchResultTable, and returns a browse session handle for use by the other browse functions.
Syntax
DESRETURN DesStartBrowseSession (DESBROWSEINFO BrowseInfo, char *pUserId, DESSMALLINT UserIdLength, char *pPassword, DESSMALLINT PasswordLength, DESBROWSESESSION *pBrowseSession, DESMESSAGE *pErrorMessage);
Function arguments
Table 14. DesStartBrowseSession arguments
Data Type | Argument | Use | Description |
---|---|---|---|
DESBROWSEINFO | BrowseInfo | input | Pointer to information needed for browsing and highlighting matches in a text document. The pointer is returned by DesGetSearchResultTable or DesGetBrowseInfo. |
char * | pUserId | input | User ID for the database |
DESSMALLINT | UserIdLength | input | Length of the user ID for the database |
char * | pPassword | input | Password for the database |
DESSMALLINT | PasswordLength | input | Length of the password for the database |
DESBROWSESESSION * | pBrowseSession | output | A handle for a browse session for use by other browse functions. |
DESMESSAGE * | pErrorMessage | output | Implementation-defined message text. If an error occurs, Text Extender returns an error code and an error message. The application program allocates the buffer of size DES_MAX_MESSAGE_LENGTH. If pErrorMessage is the null pointer, no error message is returned. |
Usage
This function opens a browse session for browsing text documents. You are prompted for your user ID and password to check your authorization to access the database.
You close the browse session by calling DesEndBrowseSession.
BrowseInfo depends on the search argument and on the base text column used for building the browse information.
Return codes
Restrictions
You must call DesGetBrowseInfo or DesGetSearchResultTable with the appropriate Browse Option before calling this function.