Vanilla.PDF  1.7.0
Cross-platform toolkit for creating and modifying PDF documents
List of all members
AnnotationHandle Class Reference

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard. More...

Inheritance diagram for AnnotationHandle:
IUnknownHandle LinkAnnotationHandle
error_type CALLING_CONVENTION Annotation_GetAnnotationType (AnnotationHandle *handle, AnnotationType *result)
 Get annotation type of object handle. More...
 
error_type CALLING_CONVENTION Annotation_ToLink (AnnotationHandle *handle, LinkAnnotationHandle **result)
 Reinterpret current object as LinkAnnotationHandle.
 
error_type CALLING_CONVENTION Annotation_Release (AnnotationHandle *handle)
 Decrement the internal reference counter. More...
 

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 annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

Member Function Documentation

◆ Annotation_GetAnnotationType()

error_type CALLING_CONVENTION Annotation_GetAnnotationType ( AnnotationHandle handle,
AnnotationType result 
)

Get annotation type of object handle.

///

Parameters
handlea handle to the annotation class
resulta pointer to variable will be filled with annotation type upon success, unchanged on failure

Friends And Related Function Documentation

◆ Annotation_Release()

error_type CALLING_CONVENTION Annotation_Release ( AnnotationHandle 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: