DestinationNameTreeHandle Class Reference

A name tree that maps string names to destination objects. This is the PDF 1.2+ method for storing named destinations, replacing the old-style /Dests dictionary in the catalog. More...

Inheritance diagram for DestinationNameTreeHandle:

error_type CALLING_CONVENTION	DestinationNameTree_Create (DestinationNameTreeHandle **result)
	Create a new empty destination name tree.
error_type CALLING_CONVENTION	DestinationNameTree_Contains (DestinationNameTreeHandle *handle, StringObjectHandle *name, boolean_type *result)
	Determine if the name tree contains a destination with the given name.
error_type CALLING_CONVENTION	DestinationNameTree_Find (DestinationNameTreeHandle *handle, StringObjectHandle *name, DestinationHandle **result)
	Find a destination by its string name.
error_type CALLING_CONVENTION	DestinationNameTree_TryFind (DestinationNameTreeHandle *handle, StringObjectHandle *name, DestinationHandle **result, boolean_type *found)
	Try to find a destination by its string name.
error_type CALLING_CONVENTION	DestinationNameTree_Insert (DestinationNameTreeHandle *handle, StringObjectHandle *name, DestinationHandle *destination)
	Insert a named destination into the tree.
error_type CALLING_CONVENTION	DestinationNameTree_Remove (DestinationNameTreeHandle *handle, StringObjectHandle *name, boolean_type *removed)
	Remove a named destination from the tree.
error_type CALLING_CONVENTION	DestinationNameTree_GetIterator (DestinationNameTreeHandle *handle, DestinationNameTreeIteratorHandle **result)
	Get an iterator to traverse all named destinations.
error_type CALLING_CONVENTION	DestinationNameTree_ToUnknown (DestinationNameTreeHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	DestinationNameTree_FromUnknown (IUnknownHandle *handle, DestinationNameTreeHandle **result)
	Convert IUnknownHandle to DestinationNameTreeHandle.
error_type CALLING_CONVENTION	DestinationNameTree_Release (DestinationNameTreeHandle *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

A name tree that maps string names to destination objects. This is the PDF 1.2+ method for storing named destinations, replacing the old-style /Dests dictionary in the catalog.

For more details please visit section 12.3.2.3 - Named Destinations.

See also

NameDictionaryHandle

Member Function Documentation

DestinationNameTree_Create()

error_type CALLING_CONVENTION DestinationNameTree_Create

(

DestinationNameTreeHandle **

result

)

Create a new empty destination name tree.

The created tree can be populated using DestinationNameTree_Insert and then assigned to a NameDictionary using NameDictionary_SetDestinations.

Friends And Related Symbol Documentation

DestinationNameTree_Find()

error_type CALLING_CONVENTION DestinationNameTree_Find ( DestinationNameTreeHandle *  handle, StringObjectHandle *  name, DestinationHandle **  result  )

related

Find a destination by its string name.

This function throws internal exception on failure. Prefer using DestinationNameTree_Contains or DestinationNameTree_TryFind for safer lookups.

DestinationNameTree_TryFind()

error_type CALLING_CONVENTION DestinationNameTree_TryFind ( DestinationNameTreeHandle *  handle, StringObjectHandle *  name, DestinationHandle **  result, boolean_type *  found  )

related

Try to find a destination by its string name.

Parameters

handle	The destination name tree handle
name	The string name to search for
result	Output: The destination handle if found, unchanged otherwise
found	Output: VANILLAPDF_RV_TRUE if found, VANILLAPDF_RV_FALSE otherwise

Returns

VANILLAPDF_ERROR_SUCCESS on success

DestinationNameTree_Insert()

error_type CALLING_CONVENTION DestinationNameTree_Insert ( DestinationNameTreeHandle *  handle, StringObjectHandle *  name, DestinationHandle *  destination  )

related

Insert a named destination into the tree.

Parameters

handle	The destination name tree handle
name	The string name for the destination
destination	The destination to insert

DestinationNameTree_Remove()

error_type CALLING_CONVENTION DestinationNameTree_Remove ( DestinationNameTreeHandle *  handle, StringObjectHandle *  name, boolean_type *  removed  )

related

Remove a named destination from the tree.

Parameters

handle	The destination name tree handle
name	The string name to remove
removed	Output: VANILLAPDF_RV_TRUE if removed, VANILLAPDF_RV_FALSE if not found

DestinationNameTree_GetIterator()

error_type CALLING_CONVENTION DestinationNameTree_GetIterator ( DestinationNameTreeHandle *  handle, DestinationNameTreeIteratorHandle **  result  )

related

Get an iterator to traverse all named destinations.

Modifying the collection may invalidate this handle.

DestinationNameTree_Release()

error_type CALLING_CONVENTION DestinationNameTree_Release ( DestinationNameTreeHandle *  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_destination_name_tree.h