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

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

Inheritance diagram for OutlineHandle:
OutlineBaseHandle IUnknownHandle
error_type CALLING_CONVENTION Outline_GetFirst (OutlineHandle *handle, OutlineItemHandle **result)
 An outline item dictionary representing the first top-level item in the outline.
 
error_type CALLING_CONVENTION Outline_GetLast (OutlineHandle *handle, OutlineItemHandle **result)
 An outline item dictionary representing the last top-level item in the outline.
 
error_type CALLING_CONVENTION Outline_GetCount (OutlineHandle *handle, IntegerObjectHandle **result)
 Total number of visible outline items at all levels of the outline.
 
error_type CALLING_CONVENTION Outline_ToOutlineBase (OutlineHandle *handle, OutlineBaseHandle **result)
 Reinterpret current object as OutlineBaseHandle.
 
error_type CALLING_CONVENTION Outline_FromOutlineBase (OutlineBaseHandle *handle, OutlineHandle **result)
 Convert OutlineBaseHandle to OutlineItemHandle.
 
error_type CALLING_CONVENTION Outline_Release (OutlineHandle *handle)
 Decrement the internal reference counter.
 

Additional Inherited Members

- Public Member Functions inherited from OutlineBaseHandle
error_type CALLING_CONVENTION OutlineBase_GetOutlineType (OutlineBaseHandle *handle, OutlineType *result)
 Get derived type of current object.
 
- Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

The root of a document's outline hierarchy.

Friends And Related Symbol Documentation

◆ Outline_GetCount()

error_type CALLING_CONVENTION Outline_GetCount ( OutlineHandle * handle,
IntegerObjectHandle ** result )
related

Total number of visible outline items at all levels of the outline.

The value cannot be negative.

This entry shall be omitted if there are no open outline items.

◆ Outline_Release()

error_type CALLING_CONVENTION Outline_Release ( OutlineHandle * 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: