Show/Hide Toolbars

Therefore Programming Interface 3.0

Executes the full text query on the server.

 

Namespace: Therefore.API

 

Visual Basic

Public Overridable Function Execute ( _

    pServer As TheServer _

) As TheFullTextQueryResult

C#

public virtual TheFullTextQueryResult Execute (

    TheServer pServer

)

 

Parameters

pServer

A valid and connected TheServer object.

 

Return Value

TheFullTextQueryResult object with document numbers and contexts containing the specified search string.

 

Exception

Condition

Null Reference Argument

pServer parameter is a null reference / null pointer.

Invalid Server

pServer does not refer to a valid and connected Therefore™ server.

Invalid Category

One or more category numbers in the Categories array are invalid.

Server Error

An error occured while executing the query on the server.

 

Required Properties

To execute a meaningful full text query you should at least:

(1) Set the Search property to the string you are looking for

(2) Add at least one category number to the Categories property

before calling the Execute method.

 

TheFullTextQuery class

TheFullTextQuery methods

TheFullTextQueryResult class

TheServer class

Categories property

Search property