Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
DestinationHandle Class Reference

Base class for all destinations. More...

Inheritance diagram for DestinationHandle:
IUnknownHandle
error_type CALLING_CONVENTION Destination_GetPageNumber (DestinationHandle *handle, ObjectHandle **result)
 The page of the document that shall be displayed.
 
error_type CALLING_CONVENTION Destination_Release (DestinationHandle *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.
 

Detailed Description

Base class for all destinations.

Member Function Documentation

◆ Destination_GetPageNumber()

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

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

Friends And Related Symbol Documentation

◆ Destination_Release()

error_type CALLING_CONVENTION Destination_Release ( DestinationHandle * 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: