ICatalogList Class Reference

#include <ICatalogList.h>

Inheritance diagram for ICatalogList:

Public Types
enum	{ kDefaultIID = IID_ICATALOGLIST }
enum	{ kQuery =0, kInProgress, kDone }

Public Member Functions
virtual ICatalog *	NewCatalog (const IDFile &catalogFile)=0
virtual ICatalog *	OpenCatalog (const IDFile &catalogFile)=0
virtual ICatalog *	RecoverCatalog (const IDFile *pubFile, const IDFile *miniSaveFile, IDataBase::ProtectionLevel protection, void *fileInfo)=0
virtual void	CloseCatalog (ICatalog *catalog)=0
virtual int32	GetCatalogCount ()=0
virtual ICatalog *	GetNthCatalog (int32 n)=0
virtual ICatalog *	FindDoc (const IDFile &catalog)=0
virtual void	Recovery (int16 &status)
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Access library catalogs. Provides ways to create, open, close, and recover catalog files.

Member Enumeration Documentation

anonymous enum

For Internal Use Only. Recovery status flags.

Member Function Documentation

virtual void ICatalogList::CloseCatalog ( ICatalog *  catalog )

pure virtual

Close a catalog.

Parameters

catalogFile

IN file specification for catalog

virtual ICatalog* ICatalogList::FindDoc ( const IDFile &  catalog )

pure virtual

Retrieve a catalog matching a file specification.

Parameters

cataloge

IN file specification for catalog

Returns

interface pointer to ICatalog found. (Not AddRef'ed, no need to Release.)

virtual int32 ICatalogList::GetCatalogCount ( )

pure virtual

Get the number of catalogs open.

Returns

the number of open catalogs

virtual ICatalog* ICatalogList::GetNthCatalog ( int32  n )

pure virtual

Iterate through open catalogs.

Parameters

n	IN catalog index to get

Returns

ICatalog interface pointer or nil

virtual ICatalog* ICatalogList::NewCatalog ( const IDFile &  catalogFile )

pure virtual

Create a new catalog. (Not AddRef'ed, no need to Release.)

Parameters

catalogFile

IN file specification for catalog

Returns

interface pointer to ICatalog created

virtual ICatalog* ICatalogList::OpenCatalog ( const IDFile &  catalogFile )

pure virtual

Open an existing catalog. (Not AddRef'ed, no need to Release.)

Parameters

catalogFile

IN file specification for catalog

Returns

interface pointer to ICatalog opened

virtual ICatalog* ICatalogList::RecoverCatalog ( const IDFile *  pubFile, const IDFile *  miniSaveFile, IDataBase::ProtectionLevel  protection, void *  fileInfo  )

pure virtual

    For Internal Use Only.  Recover a catalog.

Parameters

pubFile	IN the catalog file to recover
miniSaveFile	IN minisave file specification if it exists
protection	IN protection level
fileInfo	IN (Macintosh only) type and creator information (use nil on Windows)

Returns

interface pointer to recovered catalog

    Type and creator information block is as follows:

    <pre>

typedef struct MacintoshFileInfo { SysOSType fCreator; SysOSType fFileType; } MacintoshFileInfo;

virtual void ICatalogList::Recovery ( int16 &  status )

inlinevirtual

For Internal Use Only. Gets/sets recovery status flag for a library. Acts like a global flag.