LayerAV_Layer
ObjectSearch

The Adobe Acrobat Search plug-in allows users to perform text searches in PDF documents. It adds menus, menu items, toolbar button, and a Search panel to the Acrobat viewer.

The Search plug-in exports a Host Function Table (HFT) containing several methods that can be used by other plug-ins.

The HFT's name is Search, and its version number is 0. To use the Search plug-in's HFT, a plug-in must include the header file SrchClls.h. The plug-in must also import the HFT using ASExtensionMgrGetHFT() and assign the HFT returned by this call to a plug-in-defined global variable named gSearchHFT.

Acrobat 6.0 and later has two versions of the Search plug-in, Search (new in Acrobat 6.0) and Search5 (also available in Acrobat 5.0).

You can do the following with either version of the Search plug-in:

You cannot use either version of the Search plug-in to directly obtain the results of a search, for manipulation or for display in an application other than Adobe Acrobat.

Search supports interapplication communication (IAC) in the form of DDE messages on Windows and Apple events on Mac OS. These DDE messages and Apple events allow remote clients to submit search queries and manipulate a list of indexes (the list of indexes is referred to as the shelf).

This document describes the Search HFT. The Interapplication Communication (IAC) APIs supported by the Acrobat Search plug-in are described in Developing Applications using Interapplication Communication and the Interapplication Communication API Reference.


Define Summary
 Define
 Init_SearchHFT
 kSearchBookmarks
SearchWordOptions
 kSearchDocInfo
SearchWordOptions
 kSearchDocumentText
SearchWordOptions
 kSearchDocumentXMP
SearchWordOptions
 kSearchEveryWhere
SearchWordOptions
 kSearchJPEGExif
SearchWordOptions
 kSearchMarkup
SearchWordOptions
 kSearchPDFAttachments
SearchWordOptions
 kSearchSignatures
SearchWordOptions
 kSearchUserProperties
By including the kSearchUserProperties option, you will ensure that the object level data is the same as that seen by the menu item Object Data Tool in Acrobat. This is not the metadata associated with individual COS level objects in the PDF document.
 SearchHFT_LATEST_VERSION
 SearchHFT_NAME
 SearchNUMSELECTORS
Typedef Summary
 Typedef
 SearchIndexListPtr
 SearchIndexPtr
 SearchQueryDataRec
 SearchScope
 SearchSelector
 SearchWordOptions
The client must supply all the search word options in the scope parameter by doing an OR (|) operation on all options where the search needs to be executed. For example, if the client needs to search on attachments, and within attachments the search needs to be done on document text and XMP data, then it can be specified as follows:
Enumeration Summary
 Enumeration
  _SearchSelector
  SearchMatchOption
Search Match Options
  SearchType
Variable Summary
 Variable
 gSearchHFT
Structure Summary
 Structure
 _t_SearchQueryDataRec
Method Summary
 Method
 
SearchIndexPtr SearchAddIndex(SearchIndexListPtr list, char* fullPath, ASUns32 flags)
Superseded in Acrobat 6.0 by SearchAddIndexEx().
 
SearchIndexPtr SearchAddIndexEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags)
Supersedes SearchAddIndex() in Acrobat 6.0.
 
ASUns32 SearchCountIndexList(SearchIndexListPtr list)
Gets the number of indices currently on the shelf.
 
ASInt32 SearchExecuteQuery(char* cQuery, ASInt16 nParserID, ASUns16 nSortCount, char** cSortNames, ASBool* bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs)
Superseded in Acrobat 6.0 by SearchExecuteQueryEx(), which allows a broader range of search locations.
 
ASBool SearchExecuteQueryEx(const SearchQueryDataRec* queryData)
Supersedes SearchExecuteQuery() in Acrobat 6.0.
 
SearchIndexPtr SearchGetIndexByPath(SearchIndexListPtr list, char* fullPath)
Superseded by SearchGetIndexPathEx() in Acrobat 6.0.
 
SearchIndexPtr SearchGetIndexByPathEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath)
Supersedes SearchGetIndexPath() in Acrobat 6.0.
 
ASFileSys SearchGetIndexFileSys(SearchIndexPtr index)
Gets the file system for a specified index as an ASFileSys object.
 
ASUns32 SearchGetIndexFlags(SearchIndexPtr index)
Gets the flags for a specified index.
 
SearchIndexListPtr SearchGetIndexList()
Gets a list of the indices currently on the shelf.
 
char* SearchGetIndexPath(SearchIndexPtr index)
Superseded in Acrobat 6.0 by SearchGetIndexPathEx().
 
ASPathName SearchGetIndexPathEx(SearchIndexPtr index)
Supersedes SearchGetIndexPath() in Acrobat 6.0.
 
char* SearchGetIndexTitle(SearchIndexPtr index)
Superseded in Acrobat 6.0 by SearchGetIndexTitleEx().
 
ASText SearchGetIndexTitleEx(SearchIndexPtr index)
Supersedes SearchGetIndexTitle() in Acrobat 6.0.
 
SearchIndexPtr SearchGetNthIndex(SearchIndexListPtr list, ASUns32 n)
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.
 
ASBool SearchIsLegacySearchAvailable()
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.
 
void SearchRemoveIndex(SearchIndexListPtr list, SearchIndexPtr index)
Removes the specified index from the shelf.
 
ASUns32 SearchSetIndexFlags(SearchIndexPtr index, ASUns32 flags)
Sets the flags for a specified index.
 
ASBool SetUpSearchHFTServer()
Defines Detail
Init_SearchHFT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_SearchHFT ASExtensionMgrGetHFT(ASAtomFromString(SearchHFT_NAME), SearchHFT_LATEST_VERSION)
File: SrchHFT.h
Line: 31
kSearchBookmarks 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchBookmarks 0x00000002L
File: SrchType.h
Line: 90
kSearchDocInfo 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchDocInfo 0x00000020L
File: SrchType.h
Line: 106
kSearchDocumentText 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchDocumentText 0x00000001L
File: SrchType.h
Line: 86
kSearchDocumentXMP 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchDocumentXMP 0x00000008L
File: SrchType.h
Line: 98
kSearchEveryWhere 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchEveryWhere ASMAXUns32
File: SrchType.h
Line: 128
kSearchJPEGExif 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchJPEGExif 0x00000040L
File: SrchType.h
Line: 110
kSearchMarkup 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchMarkup 0x00000004L
File: SrchType.h
Line: 94
kSearchPDFAttachments 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchPDFAttachments 0x00000100L
File: SrchType.h
Line: 124
kSearchSignatures 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchSignatures 0x00000010L
File: SrchType.h
Line: 102
kSearchUserProperties 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchUserProperties 0x00000080L
Description

By including the kSearchUserProperties option, you will ensure that the object level data is the same as that seen by the menu item Object Data Tool in Acrobat. This is not the metadata associated with individual COS level objects in the PDF document.


File: SrchType.h
Line: 120
SearchHFT_LATEST_VERSION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SearchHFT_LATEST_VERSION (0L)
File: SrchHFT.h
Line: 29
SearchHFT_NAME 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SearchHFT_NAME "Search"
File: SrchHFT.h
Line: 28
SearchNUMSELECTORS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SearchNUMSELECTORS (SearchNUMSELECTORSplusOne - 1)
File: SrchHFT.h
Line: 44

Typedefs Detail
SearchIndexListPtr 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* SearchIndexListPtr;

File: SrchType.h
Line: 206
SearchIndexPtr 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* SearchIndexPtr;

File: SrchType.h
Line: 208
SearchQueryDataRec 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_SearchQueryDataRec SearchQueryDataRec;

File: SrchType.h
Line: 201
SearchScope 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 SearchScope;

File: SrchType.h
Line: 133
SearchSelector 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _SearchSelector SearchSelector;

File: SrchHFT.h
Line: 40
SearchWordOptions 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 SearchWordOptions;

The client must supply all the search word options in the scope parameter by doing an OR (|) operation on all options where the search needs to be executed. For example, if the client needs to search on attachments, and within attachments the search needs to be done on document text and XMP data, then it can be specified as follows:

scope = kSearchDocumentText | kSearchDocumentXMP | kSearchPDFAttachments;

In most cases, however, the client might want to search on all the places possible, so it would suffice to write:

scope = kSearchEveryWhere;


File: SrchType.h
Line: 82

Enumeration Detail
_SearchSelector
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum _SearchSelector {
 SearchBAD_SELECTOR,
 
 SearchNUMSELECTORSplusOne = (char *cQuery, ASInt16 nParserID, ASUns16 nSortCount, char **cSortNames, ASBool *bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs)(void)(SearchIndexListPtr list)(SearchIndexListPtr list, ASUns32 n)(SearchIndexListPtr list, char *fullPath)(SearchIndexListPtr list, char *fullPath, ASUns32 flags)(SearchIndexListPtr list, SearchIndexPtr index)(SearchIndexPtr index)(SearchIndexPtr index, ASUns32 flags)(SearchIndexPtr index)(SearchIndexPtr index)(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath)(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags)(SearchIndexPtr index)(SearchIndexPtr index)(SearchIndexPtr index)(void)(const SearchQueryDataRec *queryData)
}

File: SrchHFT.h
Line: 36

SearchMatchOption 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum SearchMatchOption {
 kMatchPhrase,
 
 kMatchAllWords,
 
 kMatchAnyWords,
 
 kBooleanQuery
}

File: SrchType.h
Line: 150

SearchType 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum SearchType {
 kSearchActiveDoc,
 
 kSearchFolder,
 
 kSearchIndex,
 
 kSearchActiveIndexes
}

File: SrchType.h
Line: 137

Variables Detail
gSearchHFT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gSearchHFT;

File: SrchHFT.h
Line: 53

Structure Detail
_t_SearchQueryDataRec
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_SearchQueryDataRec {
 ASSize_t size; 
 
 ASText query; 
 
 SearchType type; 
 
 SearchMatchOption match; 
 
 SearchWordOptions options; 
 
 SearchScope scope; 
 
 ASPathName path; 
 
 ASFileSys fs; 
 
 ASUns16 maxDocs; 
 
 ASUns32 startPage; 
 
 ASUns32 proximityRange; 
}

File: SrchType.h
Line: 162

Elements
size  

The size of the data structure. It must be set to sizeof(SearchQueryDataRec).

 
query  

The text to be searched.

 
type  

The location to search in.

 
match  

How the query text should be matched in the document.

 
options  

The search options.

 
scope  

The content in the PDFs that should be searched. It should be an OR of values specified in SearchScope.

 
path  

The path of the folder or index. It is required only when type is kSearchFolder or kSearchIndex.

 
fs  

The ASFileSys of the folder or index. It is required only when type is kSearchFolder or kSearchIndex.

 
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.

 
startPage  

The page number to start the search; 0 is the first page.

 
proximityRange  

The range of words for proximity searches.


Method Detail
SearchAddIndex()
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchAddIndex(SearchIndexListPtr list, char* fullPath, ASUns32 flags)

Superseded in Acrobat 6.0 by SearchAddIndexEx().

Adds a specified index to the shelf.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fullPath — 

A platform-dependent path to the index.

 
flags — 

A platform-dependent path to the index:

  • On Mac OS, it is of the form MyDisk:TopFolder:BottomFolder:Strange.pdx.

  • On Windows, it is of the form C:\LVL1\MYFILES\INDEX. On UNIX and Windows, the .PDX extension is automatically added to the specified path name.

Returns

The index that was added. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 175
SearchAddIndexEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchAddIndexEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags)

Supersedes SearchAddIndex() in Acrobat 6.0.

Adds a specified index to the shelf, using the Acrobat 6.0 file system and path mechanism.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fileSys — 

The file system on which the index is found.
 
indexPath — 

The path to the index.

 
flags — 

Flags that indicate the state of the index. It must be an 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.

Returns

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.


File: SrchPrcs.h
Line: 294
SearchCountIndexList() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 SearchCountIndexList(SearchIndexListPtr list)

Gets the number of indices currently on the shelf.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

Returns

The number of indices on the shelf.


File: SrchPrcs.h
Line: 112
SearchExecuteQuery() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 SearchExecuteQuery(char* cQuery, ASInt16 nParserID, ASUns16 nSortCount, char** cSortNames, ASBool* bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs)

Superseded in Acrobat 6.0 by SearchExecuteQueryEx(), which allows a broader range of search locations.

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.

Parameters

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 by parserID.

 
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.

 
nSortCount — 

The number of entries in the sortSpec list.

 
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.

 
bSortWays — 

An array of boolean values indicating sort order, corresponding to the array of sortSpecs with true meaning ascending and false meaning descending.

 
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).

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.

 
bOverrideWordOptions — 

Flag that indicates whether 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.

 
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.

Returns

true if successful, false otherwise.


File: SrchPrcs.h
Line: 97
SearchExecuteQueryEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SearchExecuteQueryEx(const SearchQueryDataRec* queryData)

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.

Parameters

queryData — 

A pointer to the structure containing the search parameters.

Returns

true if successful, false otherwise.

See Also

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.

File: SrchPrcs.h
Line: 350
SearchGetIndexByPath() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchGetIndexByPath(SearchIndexListPtr list, char* fullPath)

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.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fullPath — 

A platform-dependent path to the index:

  • On Mac OS, it is of the form MyDisk:TopFolder:BottomFolder:Strange.pdx.

  • On Windows, it is of the form C:\LVL1\MYFILES\INDEX. The .PDX extension is automatically added to the specified path name.

Returns

The specified index. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 145
SearchGetIndexByPathEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchGetIndexByPathEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath)

Supersedes SearchGetIndexPath() 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.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fileSys — 

The file system on which the index is found.
 
indexPath — 

The path to the index.

Returns

The specified index. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 263
SearchGetIndexFileSys() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASFileSys SearchGetIndexFileSys(SearchIndexPtr index)

Gets the file system for a specified index as an ASFileSys object.

Parameters

index — 

The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The ASFileSys object.


File: SrchPrcs.h
Line: 325
SearchGetIndexFlags() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 SearchGetIndexFlags(SearchIndexPtr index)

Gets the flags for a specified index.

Parameters

index — 

The index whose flags are to be obtained (set). The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

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.


File: SrchPrcs.h
Line: 197
SearchGetIndexList() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexListPtr SearchGetIndexList()

Gets a list of the indices currently on the shelf.

Returns

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.


File: SrchPrcs.h
Line: 105
SearchGetIndexPath() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

char* SearchGetIndexPath(SearchIndexPtr index)

Superseded in Acrobat 6.0 by SearchGetIndexPathEx().

Gets the platform-dependent path for a specified index.

Parameters

index — 

The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

A platform-dependent path to the index:

  • On Windows, it is of the form C:\LVL1\MYFILES\INDEX. The .PDX extension is automatically added to the specified path name.

  • On Mac OS, it is of the form MyDisk:TopFolder:BottomFolder:Strange.pdx.


File: SrchPrcs.h
Line: 245
SearchGetIndexPathEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASPathName SearchGetIndexPathEx(SearchIndexPtr index)

Supersedes SearchGetIndexPath() in Acrobat 6.0.

Gets the path for a specified index as an ASPathName object.

Parameters

index — 

The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The ASPathName object.


File: SrchPrcs.h
Line: 316
SearchGetIndexTitle() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

char* SearchGetIndexTitle(SearchIndexPtr index)

Superseded in Acrobat 6.0 by SearchGetIndexTitleEx().

Gets the title of a specified index.

Parameters

index — 

The index whose title is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The title of the specified index.


File: SrchPrcs.h
Line: 229
SearchGetIndexTitleEx() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASText SearchGetIndexTitleEx(SearchIndexPtr index)

Supersedes SearchGetIndexTitle() in Acrobat 6.0.

Gets the title of a specified index as an ASText object.

Parameters

index — 

The index whose title is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The title of the specified index as an ASText object.


File: SrchPrcs.h
Line: 305
SearchGetNthIndex() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchGetNthIndex(SearchIndexListPtr list, ASUns32 n)

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.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
n — 

The index to get. The first index on the shelf is index zero.

Returns

The nth index on the shelf. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 125
SearchIsLegacySearchAvailable() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SearchIsLegacySearchAvailable()

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.

Returns

true if legacy searches are available, false otherwise.


File: SrchPrcs.h
Line: 334
SearchRemoveIndex() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void SearchRemoveIndex(SearchIndexListPtr list, SearchIndexPtr index)

Removes the specified index from the shelf.

Parameters

list — 

IN The list of indices on the shelf, obtained using SearchGetIndexList().

 
index — 

IN The index to be removed. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().


File: SrchPrcs.h
Line: 182
SearchSetIndexFlags() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 SearchSetIndexFlags(SearchIndexPtr index, ASUns32 flags)

Sets the flags for a specified index.

Parameters

index — 

The index whose flags are to be set. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

 
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.

Returns

The flags returned are the actual values set, and may not always be the same as the requested value.


File: SrchPrcs.h
Line: 218
SetUpSearchHFTServer() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SetUpSearchHFTServer()

Returns

File: SrchHFT.h
Line: 54



© 2004-2013 Adobe Systems Incorporated. All rights reserved.
Thu Jan 21 2016, 11:19 AM IST