NameDictionaryHandle Class Reference

The name dictionary (PDF 1.2+) associates names with various document objects using name trees for efficient lookup. More...

Inheritance diagram for NameDictionaryHandle:

error_type CALLING_CONVENTION	NameDictionary_Create (NameDictionaryHandle **result)
	Create a new empty name dictionary.
error_type CALLING_CONVENTION	NameDictionary_ContainsDestinations (NameDictionaryHandle *handle, boolean_type *result)
	Check if the name dictionary contains a Dests name tree.
error_type CALLING_CONVENTION	NameDictionary_GetDestinations (NameDictionaryHandle *handle, DestinationNameTreeHandle **result)
	Get the Dests name tree from the name dictionary.
error_type CALLING_CONVENTION	NameDictionary_SetDestinations (NameDictionaryHandle *handle, DestinationNameTreeHandle *destinations)
	Set the Dests name tree in the name dictionary.
error_type CALLING_CONVENTION	NameDictionary_ToUnknown (NameDictionaryHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	NameDictionary_FromUnknown (IUnknownHandle *handle, NameDictionaryHandle **result)
	Convert IUnknownHandle to NameDictionaryHandle.
error_type CALLING_CONVENTION	NameDictionary_Release (NameDictionaryHandle *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 name dictionary (PDF 1.2+) associates names with various document objects using name trees for efficient lookup.

For more details please visit section 7.7.4 - Name Dictionary.

See also

CatalogHandle

Member Function Documentation

NameDictionary_Create()

error_type CALLING_CONVENTION NameDictionary_Create

(

NameDictionaryHandle **

result

)

Create a new empty name dictionary.

The created dictionary can be assigned to a catalog using Catalog_SetNames.

Friends And Related Symbol Documentation

NameDictionary_GetDestinations()

error_type CALLING_CONVENTION NameDictionary_GetDestinations ( NameDictionaryHandle *  handle, DestinationNameTreeHandle **  result  )

related

Get the Dests name tree from the name dictionary.

The Dests name tree maps destination names (strings) to destination objects. Use NameDictionary_ContainsDestinations to check if the tree exists.

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if the Dests tree does not exist

NameDictionary_SetDestinations()

error_type CALLING_CONVENTION NameDictionary_SetDestinations ( NameDictionaryHandle *  handle, DestinationNameTreeHandle *  destinations  )

related

Set the Dests name tree in the name dictionary.

This replaces any existing Dests tree with the provided one.

NameDictionary_Release()

error_type CALLING_CONVENTION NameDictionary_Release ( NameDictionaryHandle *  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_name_dictionary.h