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:

error_type CALLING_CONVENTION	PageAnnotations_Create (PageAnnotationsHandle **result)
	Create a new empty annotation collection.
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_Append (PageAnnotationsHandle *handle, AnnotationHandle *annotation)
	Append an annotation to the collection.
error_type CALLING_CONVENTION	PageAnnotations_Remove (PageAnnotationsHandle *handle, size_type at)
	Remove an annotation from the collection at the specified 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.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement 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

Member Function Documentation

PageAnnotations_Create()

error_type CALLING_CONVENTION PageAnnotations_Create

(

PageAnnotationsHandle **

result

)

Create a new empty annotation collection.

Parameters

result

a pointer to variable that will contain the new collection upon success

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

handle	a handle to annotation collection
at	position of the element in the handle collection
result	a pointer to variable, that will contain annotation upon success, unchanged on failure

PageAnnotations_Append()

error_type CALLING_CONVENTION PageAnnotations_Append ( PageAnnotationsHandle *  handle, AnnotationHandle *  annotation  )

related

Append an annotation to the collection.

Parameters

handle	a handle to annotation collection
annotation	the annotation to append

PageAnnotations_Remove()

error_type CALLING_CONVENTION PageAnnotations_Remove ( PageAnnotationsHandle *  handle, size_type  at  )

related

Remove an annotation from the collection at the specified position.

Parameters

handle	a handle to annotation collection
at	position of the element to remove from the handle collection

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:

• c_annotations.h