LayerAV_Layer
ObjectCatalog

Acrobat Catalog is a plug-in that allows you to create a full-text index of a set of PDF documents. A full-text index is a searchable database of all the text in the documents. After building an index, you can use the Search command to search the entire library quickly. Searches of full-text indexes created using Catalog are faster and more convenient than using the Find command.

The Catalog plug-in has an HFT consisting of several methods that plug-in developers can import and use. In addition, Catalog supports DDE, and broadcasts several Windows messages.

Catalog DDE

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


Define Summary
 Define
 CatalogHFT_Error
 CatalogHFT_LATEST_VERSION
 CatalogHFT_NAME
 CatalogNUMSELECTORS
 CatalogRealHFT_NAME
 Init_CatalogHFT
 kIndexAvailableFlag
The index is available for searching.
 kIndexExists
 kIndexPtrInvalidFlag
(Read only - cannot be set)
 kIndexSelectedFlag
The index is used for searching.
Enumeration Summary
 Enumeration
  CatalogStatus
Return values for the current state of Catalog. If Catalog is currently busy performing some operation, it returns the relevant state, which could be CatalogBuilding, CatalogPurging, or CatalogWaiting.
  IndexStatus
Return values for the current state of the Index after a call to Purge, Build, or Load an index.
Variable Summary
 Variable
 gCatalogHFT
Method Summary
 Method
 
void CatalogActivate()
Launch Catalog. If Catalog is already launched, its window is activated.
 
IndexStatus CatalogBuildIndex(char* szIndex)
Builds an index. If Catalog is not already open, it is launched.
 
CatalogStatus CatalogGiveStatus()
Returns the current status of Catalog.
 
IndexStatus CatalogLoadIndex(char* szIndex)
Opens an already existing index. If Catalog is not already open, it is launched.
 
IndexStatus CatalogPurgeIndex(char* szIndex)
Purges an already existing index. If Catalog is not already open, it is launched.
 
ASBool SetUpCatalogHFTServer()
Defines Detail
CatalogHFT_Error 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogHFT_Error 1
File: cathft.h
Line: 27
CatalogHFT_LATEST_VERSION 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogHFT_LATEST_VERSION (0L)
File: cathft.h
Line: 26
CatalogHFT_NAME 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogHFT_NAME "Catalog"
File: cathft.h
Line: 24
CatalogNUMSELECTORS 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogNUMSELECTORS (CatalogNUMSELECTORSplusOne - 1)
File: cathft.h
Line: 83
CatalogRealHFT_NAME 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogRealHFT_NAME ("$"CatalogHFT_NAME)
File: cathft.h
Line: 25
Init_CatalogHFT 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_CatalogHFT ASExtensionMgrGetHFT(ASAtomFromString(CatalogHFT_NAME), CatalogHFT_LATEST_VERSION)
File: cathft.h
Line: 29
kIndexAvailableFlag 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexAvailableFlag (1L << 0)
Description

The index is available for searching.

Indices that are not available appear grayed out in the Search plug-in's user interface.


File: SrchType.h
Line: 218
kIndexExists 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexExists ((SearchIndexPtr)-1)
File: SrchType.h
Line: 236
kIndexPtrInvalidFlag 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexPtrInvalidFlag (1L << 31)
Description

(Read only - cannot be set)

The index cannot be located; it does not exist. In practice, kIndexAvailableFlag should always be set.


File: SrchType.h
Line: 233
kIndexSelectedFlag 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexSelectedFlag (1L << 1)
Description

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.


File: SrchType.h
Line: 226


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

Syntax

enum CatalogStatus {
 CatalogIdle = 0,
 
 CatalogBuilding,
 
 CatalogPurging,
 
 CatalogWaiting
}

File: cathft.h
Line: 49

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

Syntax

enum IndexStatus {
 IndexInvalid = 0,
 
 IndexCouldNotBeSaved,
 
 IndexBuildDone,
 
 IndexPurgeDone,
 
 IndexLoadDone,
 
 CatalogBusy,
 
 IndexJobAdded
}

File: cathft.h
Line: 65

Elements
IndexInvalid  

Input path is not correct, or Catalog was not able to load the index.

 
IndexCouldNotBeSaved  

Catalog was unable to save the index at the given path.

 
IndexBuildDone  

The build operation was valid and was completed.

 
IndexPurgeDone  

The purge operation was valid and was completed.

 
IndexLoadDone  

The index was loaded successfully.

 
CatalogBusy  

Catalog is currently busy and could not process the request.

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

Syntax

HFT gCatalogHFT;

File: cathft.h
Line: 85


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

Syntax

void CatalogActivate()

Launch Catalog. If Catalog is already launched, its window is activated.

See Also

CatalogGiveStatus
CatalogLoadIndex

File: catprocs.h
Line: 24
CatalogBuildIndex() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

IndexStatus CatalogBuildIndex(char* szIndex)

Builds an index. If Catalog is not already open, it is launched.

Parameters

szIndex — 

The destination path of the index (including the .pdx extension).

Returns

The status after the build is done. If Catalog is busy, it returns CatalogBusy.

See Also

CatalogActivate
CatalogLoadIndex
CatalogPurgeIndex

File: catprocs.h
Line: 50
CatalogGiveStatus() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

CatalogStatus CatalogGiveStatus()

Returns the current status of Catalog.

Returns

The current status of Catalog.


File: catprocs.h
Line: 65
CatalogLoadIndex() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

IndexStatus CatalogLoadIndex(char* szIndex)

Opens an already existing index. If Catalog is not already open, it is launched.

Parameters

szIndex — 

The full path of the index (including the .pdx extension). If it is invalid, the method does nothing.

Returns

The status after the index definition dialog box is closed. If Catalog is busy, it returns CatalogBusy.

See Also

CatalogActivate
CatalogPurgeIndex

Exceptions

None

File: catprocs.h
Line: 36
CatalogPurgeIndex() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

IndexStatus CatalogPurgeIndex(char* szIndex)

Purges an already existing index. If Catalog is not already open, it is launched.

Parameters

szIndex — 

IN The full path of the index (including the .pdx extension). If it is invalid, the method does nothing.

Returns

The status after the purge is done. If Catalog is busy, it returns CatalogBusy.

See Also

CatalogActivate
CatalogBuildIndex
CatalogPurgeIndex

File: catprocs.h
Line: 60
SetUpCatalogHFTServer() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SetUpCatalogHFTServer()

Returns

File: cathft.h
Line: 86



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