Executes a specified query, using the set of indices currently on the shelf. The search results are displayed in the Acrobat Search plug-in's Results window.
@param cQuery The query. Its format is the same as what a user would type into the Search query dialog, and depends on the search language specified byparserID.
@param nParserID The search language used in the query.
It must be one of the following values (see SrchType.h):
| Value | Description |
|---|---|
| kParserSimple | Allows only simple phrase searches; it does not allow boolean searching. |
| kParserCQL | Allows boolean searches using AND, OR, and NOT, as described in the Acrobat Search plug-in's online help file. |
| kParserBPlus | The Verity BooleanPlus query language. Contact Verity for further information on this language. |
sortSpec
list.
@param cSortNames An array of strings, each specifying a
key whose value is used to sort the search results. The
first entry is the primary sort key, the second is the secondary
sort key, and so forth. Each string may be any field that
appears in the index, plus Score (which sorts results by
relevance ranking). Some common fields are Title, ModificationDate,
CreationDate, and Keywords.
@param bSortWays An array of boolean values indicating sort order,
corresponding to the array of sortSpecs with true meaning ascending and
false meaning descending.
@param nWordOptions Search options. It must be an OR of the
following values (see SrchType.h):
| Value | Description |
|---|---|
| kWordOptionCase | The search is case-sensitive. |
| kWordOptionStemming | Find not only the specified word, but other words that have the same stem (for example, run and ran have the same stem). |
| kWordOptionSoundsLike | Find not only the specified word, but other words that sound like it. |
| kWordOptionThesaurus | Find not only the specified word, but other words that have the same meaning. |
| kWordOptionProximity | Consider the proximity of results
when using the AND operator to look for more than one word
in a document. Without this option, ANDed terms can be anywhere
in a document. Searching for "red" and "blue", for example,
finds a document where "red" is the first word on the first
page and "blue" is the last word on the last page.
With this option, however, ANDed terms must be within two
or three pages of each other to be found. Also, the closer
ANDed terms appear together, the higher the relevance ranking
of the document that contains them. |
| kWordOptionRefine | Do not search the entire list of indices, but only the
documents that matched the previous search. This is used
to refine the results of the previous search. The manner
in which wordOptions is used depends on the value of overrideWordOptions. |
wordOptions is ORed with the search options set in the user
interface, or is used instead of them. If it is 0, wordOptions is
ORed with the user interface search options, and the resulting
value is used. If it is non-zero, wordOptions is used instead
of the user interface search options.
@param nMaxDocs The maximum number of documents to display
in the Results window. If more documents than this have
hits, only the first maxDocs are displayed. maxDocs must
be no greater than 9999.
@return true if successful, false otherwise.
*/
PIPROC(ASInt32, SearchExecuteQuery, (char *cQuery, ASInt16 nParserID, ASUns16 nSortCount, char **cSortNames, ASBool *bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs), cQuery, nParserID, nSortCount, cSortNames, bSortWays, nWordOptions, bOverrideWordOptions, nMaxDocs)
/**
Gets a list of the indices currently on the shelf.
@return The list of indices currently on the shelf. This value can
subsequently be used by other Search plug-in methods to
obtain information about a specific index, the number of
indices on the shelf, and so forth.
*/
PIPROC(SearchIndexListPtr, SearchGetIndexList, (void), )
/**
Gets the number of indices currently on the shelf.
@param list The list of indices on the shelf, obtained
using SearchGetIndexList().
@return The number of indices on the shelf.
*/
PIPROC(ASUns32, SearchCountIndexList, (SearchIndexListPtr list), list)
/**
Gets the nth index on the shelf. The index can be passed
to other Search plug-in methods to remove it from the
shelf, obtain its title, and so forth.
@param list The list of indices on the shelf, obtained
using SearchGetIndexList().
@param n The index to get. The first index on the shelf
is index zero.
@return The nth index on the shelf. This value may be used in subsequent
calls to remove the index, obtain its title, and so forth.
*/
PIPROC(SearchIndexPtr, SearchGetNthIndex, (SearchIndexListPtr list, ASUns32 n), list, n)
/**
Superseded by SearchGetIndexPathEx() in Acrobat 6.0.
Gets the index that has the specified path. The index must already be on the shelf. The index can be passed to other Search plug-in methods to remove it from the shelf, obtain its title, and so forth.
@param list The list of indices on the shelf, obtained using SearchGetIndexList(). @param fullPath A platform-dependent path to the index:MyDisk:TopFolder:BottomFolder:Strange.pdx. C:\\LVL1\\MYFILES\\INDEX. The .PDX extension is automatically added to the
specified path name.Adds a specified index to the shelf.
@param list The list of indices on the shelf, obtained using SearchGetIndexList(). @param fullPath A platform-dependent path to the index. @param fullPath A platform-dependent path to the index:MyDisk:TopFolder:BottomFolder:Strange.pdx. C:\\LVL1\\MYFILES\\INDEX. On UNIX and Windows, the .PDX extension is automatically added to the
specified path name.OR of the following values (see SrchType.h):
| Value | Description |
|---|---|
| kIndexAvailableFlag | The index is available for searching. Indices that are not available appear grayed out in the Search plug-in's user interface. |
| kIndexSelectedFlag | The index is used for searching. Indices that are selected appear with a filled in check box in the Search plug-in's user interface. |
| kIndexPtrInvalidFlag | (Read only: cannot be set). The index cannot be located; it does not exist. |
In practice, kIndexAvailableFlag should always be set.
@return The index that was added. This value may be used in subsequent calls to remove the index, obtain its title, and so forth. */ PIPROC(SearchIndexPtr, SearchAddIndex, (SearchIndexListPtr list, char *fullPath, ASUns32 flags), list, fullPath, flags) /** Removes the specified index from the shelf. @param list IN The list of indices on the shelf, obtained using SearchGetIndexList(). @param index IN The index to be removed. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). */ PIPROC(void, SearchRemoveIndex, (SearchIndexListPtr list, SearchIndexPtr index), list, index) /** Gets the flags for a specified index. @param index The index whose flags are to be obtained (set). The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @return The flags returned are the actual values set, and may not always be the same as the requested value. It gets a list of the indices currently on the shelf.The list of indices currently on the shelf is returned. This value can subsequently be used by other Search plug-in methods to obtain information about a specific index, the number of indices on the shelf, and so forth.
*/ PIPROC(ASUns32, SearchGetIndexFlags, (SearchIndexPtr index), index) /** Sets the flags for a specified index. @param index The index whose flags are to be set. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @param flags Flags that indicate the status of the index.flags must be an OR of the values (see SrchType.h):
| Value | Description |
|---|---|
| kIndexAvailableFlag | The index is available for searching. Indices that are not available appear grayed out in the Search plug-in's user interface. |
| kIndexSelectedFlag | The index is used for searching. Indices that are selected appear with a filled in check box in the Search plug-in's user interface. |
| kIndexPtrInvalidFlag | (Read only: cannot be set). The index cannot be located; it does not exist. |
In practice, kIndexAvailableFlag should always be set.
@return The flags returned are the actual values set, and may not always be the same as the requested value. */ PIPROC(ASUns32, SearchSetIndexFlags, (SearchIndexPtr index, ASUns32 flags), index, flags) /** Superseded in Acrobat 6.0 by SearchGetIndexTitleEx().Gets the title of a specified index.
@param index The index whose title is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @return The title of the specified index. */ PIPROC(char *, SearchGetIndexTitle, (SearchIndexPtr index), index) /** Superseded in Acrobat 6.0 by SearchGetIndexPathEx(). Gets the platform-dependent path for a specified index. @param index The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @return A platform-dependent path to the index:C:\\LVL1\\MYFILES\\INDEX. The .PDX extension is automatically added to the
specified path name.MyDisk:TopFolder:BottomFolder:Strange.pdx. Gets the index that has the specified path. The index must already be on the shelf. The index can be passed to other Search plug-in methods to remove it from the shelf, obtain its title, and so forth.
@param list The list of indices on the shelf, obtained using SearchGetIndexList(). @param fileSys The file system on which the index is found. @param indexPath The path to the index. @return The specified index. This value may be used in subsequent calls to remove the index, obtain its title, and so forth. */ PIPROC(SearchIndexPtr, SearchGetIndexByPathEx, (SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath), list, fileSys, indexPath) /** Supersedes SearchAddIndex() in Acrobat 6.0.Adds a specified index to the shelf, using the Acrobat 6.0 file system and path mechanism.
@param list The list of indices on the shelf, obtained using SearchGetIndexList(). @param fileSys The file system on which the index is found. @param indexPath The path to the index. @param flags Flags that indicate the state of the index. It must be anOR of the following values (see SrchType.h):
| Value | Description |
|---|---|
| kIndexAvailableFlag | The index is available for searching. Indices that are not available appear grayed out in the Search plug-in's user interface. |
| kIndexSelectedFlag | The index is used for searching. Indices that are selected appear with a filled in check box in the Search plug-in's user interface. |
| kIndexPtrInvalidFlag | (Read only: cannot be set). The index cannot be located; it does not exist. |
In practice, kIndexAvailableFlag should always be set.
@return The index that was added. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.It returns kAddIndexFailed if the specified index could not be added to the shelf. It returns kIndexExists if the index is already on the shelf.
*/ PIPROC(SearchIndexPtr, SearchAddIndexEx, (SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags), list, fileSys, indexPath, flags) /** Supersedes SearchGetIndexTitle() in Acrobat 6.0.Gets the title of a specified index as an ASText object.
@param index The index whose title is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @return The title of the specified index as an ASText object. */ PIPROC(ASText, SearchGetIndexTitleEx, (SearchIndexPtr index), index) /** Supersedes SearchGetIndexPath() in Acrobat 6.0.Gets the path for a specified index as an ASPathName object.
@param index The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @return The ASPathName object. */ PIPROC(ASPathName, SearchGetIndexPathEx, (SearchIndexPtr index), index) /** Gets the file system for a specified index as an ASFileSys object. @param index The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex(). @return The ASFileSys object. */ PIPROC(ASFileSys, SearchGetIndexFileSys, (SearchIndexPtr index), index) /** Tests whether the search mechanism (Search5) for previous Acrobat versions (prior to 6.0) is available for the current system. When Search5 is available, you can search indexes from Acrobat 5.0 and earlier. @returntrue if legacy searches are available, false otherwise.
*/
PIPROC(ASBool, SearchIsLegacySearchAvailable, (void), )
/**
Supersedes SearchExecuteQuery() in Acrobat 6.0.
Executes a specified query, using the given set of search parameters. The search results are displayed in the Acrobat Search plug-in's Results window.
@param queryData A pointer to the structure containing the search parameters. @returntrue if successful, false otherwise.
@see maxDocs The maximum number of documents to display in the
Results window. If more documents than this have hits, only
the first maxDocs are displayed. maxDocs must be no greater
than 999.
*/
PIPROC(ASBool, SearchExecuteQueryEx, (const SearchQueryDataRec *queryData), queryData)