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

An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle associated with the page. More...

Inheritance diagram for PageAnnotationsHandle:
IUnknownHandle
error_type CALLING_CONVENTION PageAnnotations_GetSize (PageAnnotationsHandle *handle, size_type *result)
 Get size of annotation array.
 
error_type CALLING_CONVENTION PageAnnotations_At (PageAnnotationsHandle *handle, size_type at, AnnotationHandle **result)
 Get single annotation from array at specific position.
 
error_type CALLING_CONVENTION PageAnnotations_ToUnknown (PageAnnotationsHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type CALLING_CONVENTION PageAnnotations_FromUnknown (IUnknownHandle *handle, PageAnnotationsHandle **result)
 Convert IUnknownHandle to PageAnnotationsHandle.
 
error_type CALLING_CONVENTION PageAnnotations_Release (PageAnnotationsHandle *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

An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle associated with the page.

See also
PageObjectHandle

Friends And Related Symbol Documentation

◆ PageAnnotations_At()

error_type CALLING_CONVENTION PageAnnotations_At ( PageAnnotationsHandle * handle,
size_type at,
AnnotationHandle ** result )
related

Get single annotation from array at specific position.

Parameters
handlea handle to annotation collection
atposition of the element in the handle collection
resulta pointer to variable, that will contain annotation upon success, unchanged on failure

◆ PageAnnotations_Release()

error_type CALLING_CONVENTION PageAnnotations_Release ( PageAnnotationsHandle * 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: