DestinationHandle Class Reference

Base class for all destinations. More...

Inheritance diagram for DestinationHandle:

error_type CALLING_CONVENTION	Destination_CreateFromArray (ArrayObjectHandle *array_handle, DestinationHandle **result)
	Create a destination from an array object.
error_type CALLING_CONVENTION	Destination_CreateFromDictionary (DictionaryObjectHandle *dict_handle, DestinationHandle **result)
	Create a destination from a dictionary object.
error_type CALLING_CONVENTION	Destination_GetDestinationType (DestinationHandle *handle, DestinationType *result)
	Get the type of destination to determine available parameters.
error_type CALLING_CONVENTION	Destination_GetPageNumber (DestinationHandle *handle, ObjectHandle **result)
	The page of the document that shall be displayed.

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

Base class for all destinations.

Member Function Documentation

Destination_CreateFromArray()

error_type CALLING_CONVENTION Destination_CreateFromArray	(	ArrayObjectHandle *	array_handle,
		DestinationHandle **	result
	)

Create a destination from an array object.

Array format: [page /Type ...] The array should contain at least the page reference and destination type.

Parameters

array_handle	Array object containing destination parameters
result	Pointer to receive the created destination handle

Returns

VANILLAPDF_ERROR_SUCCESS on success, error otherwise

Friends And Related Symbol Documentation

Destination_CreateFromDictionary()

error_type CALLING_CONVENTION Destination_CreateFromDictionary ( DictionaryObjectHandle *  dict_handle, DestinationHandle **  result  )

related

Create a destination from a dictionary object.

Dictionary format: {/D [page /Type ...]} The dictionary should contain a /D entry with the destination array.

Parameters

dict_handle	Dictionary object containing /D entry with destination parameters
result	Pointer to receive the created destination handle

Returns

VANILLAPDF_ERROR_SUCCESS on success, error otherwise

Destination_GetPageNumber()

error_type CALLING_CONVENTION Destination_GetPageNumber ( DestinationHandle *  handle, ObjectHandle **  result  )

related

The page of the document that shall be displayed.

The object type shall be either IntegerObjectHandle or IndirectReferenceObjectHandle.

IntegerObjectHandle means index in document's page tree.

IndirectReferenceObjectHandle means it is indirect reference to PageObjectHandle representing the destination page.

See also

PageTreeHandle

---

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

• c_destinations.h