CatalogHandle Class Reference

The root of a document's object hierarchy. More...

Inheritance diagram for CatalogHandle:

error_type CALLING_CONVENTION	Catalog_GetPages (CatalogHandle *handle, PageTreeHandle **result)
	The root of the document's page tree (see 7.7.3, "Page Tree").
error_type CALLING_CONVENTION	Catalog_GetPageLabels (CatalogHandle *handle, PageLabelsHandle **result)
	A number tree defining the page labelling for the document (see 12.4.2, "Page Labels").
error_type CALLING_CONVENTION	Catalog_GetPageLayout (CatalogHandle *handle, PageLayout *result)
	Page layout which shall be used when the document is opened.
error_type CALLING_CONVENTION	Catalog_GetVersion (CatalogHandle *handle, PDFVersion *result)
	The version of the PDF specification to which the document conforms if later than the version specified in the file's header.
error_type CALLING_CONVENTION	Catalog_GetExtensions (CatalogHandle *handle, DeveloperExtensionsHandle **result)
	An extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document.
error_type CALLING_CONVENTION	Catalog_GetViewerPreferences (CatalogHandle *handle, ViewerPreferencesHandle **result)
	The way the document shall be displayed on the screen.
error_type CALLING_CONVENTION	Catalog_GetOutlines (CatalogHandle *handle, OutlineHandle **result)
	Root of the document's outline hierarchy (see 12.3.3, "Document Outline").
error_type CALLING_CONVENTION	Catalog_GetDestinations (CatalogHandle *handle, NamedDestinationsHandle **result)
	A dictionary of names and corresponding destinations (see 12.3.2.3, "Named Destinations").
error_type CALLING_CONVENTION	Catalog_GetNames (CatalogHandle *handle, NameDictionaryHandle **result)
	The document's name dictionary (see 7.7.4, "Name Dictionary").
error_type CALLING_CONVENTION	Catalog_SetNames (CatalogHandle *handle, NameDictionaryHandle *names)
	Set the document's name dictionary (see 7.7.4, "Name Dictionary").
error_type CALLING_CONVENTION	Catalog_GetAcroForm (CatalogHandle *handle, InteractiveFormHandle **result)
	The document's interactive form (see 12.7, "Interactive Forms").
error_type CALLING_CONVENTION	Catalog_GetOpenAction (CatalogHandle *handle, ObjectHandle **result)
	Get the open action entry from the catalog.
error_type CALLING_CONVENTION	Catalog_ToUnknown (CatalogHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	Catalog_FromUnknown (IUnknownHandle *handle, CatalogHandle **result)
	Convert IUnknownHandle to CatalogHandle.
error_type CALLING_CONVENTION	Catalog_Release (CatalogHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

The root of a document's object hierarchy.

See also

DocumentHandle

Examples

extract.c, and verify.c.

Friends And Related Symbol Documentation

Catalog_GetPageLayout()

error_type CALLING_CONVENTION Catalog_GetPageLayout ( CatalogHandle *  handle, PageLayout *  result  )

related

Page layout which shall be used when the document is opened.

Catalog_GetVersion()

error_type CALLING_CONVENTION Catalog_GetVersion ( CatalogHandle *  handle, PDFVersion *  result  )

related

The version of the PDF specification to which the document conforms if later than the version specified in the file's header.

If the header specifies a later version, or if this entry is absent, the document shall conform to the version specified in the header.

Catalog_GetExtensions()

error_type CALLING_CONVENTION Catalog_GetExtensions ( CatalogHandle *  handle, DeveloperExtensionsHandle **  result  )

related

An extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document.

7.12, "Extensions Dictionary", describes this dictionary and how it shall be used.

Catalog_GetViewerPreferences()

error_type CALLING_CONVENTION Catalog_GetViewerPreferences ( CatalogHandle *  handle, ViewerPreferencesHandle **  result  )

related

The way the document shall be displayed on the screen.

If this entry is absent, conforming readers shall use their own current user preference settings.

Catalog_GetDestinations()

error_type CALLING_CONVENTION Catalog_GetDestinations ( CatalogHandle *  handle, NamedDestinationsHandle **  result  )

related

A dictionary of names and corresponding destinations (see 12.3.2.3, "Named Destinations").

Note

This is the old-style /Dests dictionary. For PDF 1.2+, prefer using Catalog_GetNames to access the /Names dictionary.

Catalog_GetNames()

error_type CALLING_CONVENTION Catalog_GetNames ( CatalogHandle *  handle, NameDictionaryHandle **  result  )

related

The document's name dictionary (see 7.7.4, "Name Dictionary").

The name dictionary contains name trees that map strings to various document objects, including destinations, JavaScript actions, embedded files, etc.

Catalog_GetOpenAction()

error_type CALLING_CONVENTION Catalog_GetOpenAction ( CatalogHandle *  handle, ObjectHandle **  result  )

related

Get the open action entry from the catalog.

The returned object can be either an array (destination) or a dictionary (action). Use Object_GetType to determine the type, then convert using Destination_FromObject or Action_FromDictionary.

Catalog_Release()

error_type CALLING_CONVENTION Catalog_Release ( CatalogHandle *  handle )

related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

IUnknown_Release

---

The documentation for this class was generated from the following file:

• c_catalog.h