vanillapdf/c__page__tree_8h_source.html

#ifndef _C_PAGE_TREE_H

#define _C_PAGE_TREE_H


#include "vanillapdf/c_export.h"

#include "vanillapdf/c_handles.h"

#include "vanillapdf/c_values.h"


#ifdef __cplusplus

extern "C"

{

#endif


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_GetPageCount(PageTreeHandle* handle, size_type* result);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_GetPage(PageTreeHandle* handle, size_type at, PageObjectHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_WarmPageCache(PageTreeHandle* handle);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_InsertPage(PageTreeHandle* handle, size_type at, PageObjectHandle* page);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_AppendPage(PageTreeHandle* handle, PageObjectHandle* page);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_RemovePage(PageTreeHandle* handle, size_type at);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_FindPageIndex(PageTreeHandle* handle, ObjectHandle* page_ref, size_type* result);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_ToUnknown(PageTreeHandle* handle, IUnknownHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_FromUnknown(IUnknownHandle* handle, PageTreeHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION PageTree_Release(PageTreeHandle* handle);


#ifdef __cplusplus

};

#endif


#endif /* _C_PAGE_TREE_H */

c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.

c_handles.h
This file contains all type forward declarations returned by the library API.

c_values.h
This file contains types and constants used as parameters or return values.

IUnknownHandle
Base class for reference counting.

ObjectHandle
Base class for syntactic tokens.

PageObjectHandle
The leaves of the page tree are page objects, each of which is a dictionary specifying the attributes...

PageTreeHandle
The pages of a document are accessed through a structure known as the page tree, which defines the or...

PageTreeHandle::PageTree_ToUnknown
error_type CALLING_CONVENTION PageTree_ToUnknown(PageTreeHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.

PageTreeHandle::PageTree_Release
error_type CALLING_CONVENTION PageTree_Release(PageTreeHandle *handle)
Decrement the internal reference counter.

PageTreeHandle::PageTree_FromUnknown
error_type CALLING_CONVENTION PageTree_FromUnknown(IUnknownHandle *handle, PageTreeHandle **result)
Convert IUnknownHandle to PageTreeHandle.

PageTreeHandle::PageTree_AppendPage
error_type CALLING_CONVENTION PageTree_AppendPage(PageTreeHandle *handle, PageObjectHandle *page)
Adds a new page at the end of the page tree, after its current last element.

PageTreeHandle::PageTree_RemovePage
error_type CALLING_CONVENTION PageTree_RemovePage(PageTreeHandle *handle, size_type at)
Removed a page at the 1-based index at.

PageTreeHandle::PageTree_InsertPage
error_type CALLING_CONVENTION PageTree_InsertPage(PageTreeHandle *handle, size_type at, PageObjectHandle *page)
Insert new page at the 1-based index at.

PageTreeHandle::PageTree_GetPageCount
error_type CALLING_CONVENTION PageTree_GetPageCount(PageTreeHandle *handle, size_type *result)
Get total number of pages in current document.

PageTreeHandle::PageTree_GetPage
error_type CALLING_CONVENTION PageTree_GetPage(PageTreeHandle *handle, size_type at, PageObjectHandle **result)
Get page at the 1-based index at.

PageTreeHandle::PageTree_WarmPageCache
error_type CALLING_CONVENTION PageTree_WarmPageCache(PageTreeHandle *handle)
Pre-warm the page cache by walking the entire page tree once.

PageTreeHandle::PageTree_FindPageIndex
error_type CALLING_CONVENTION PageTree_FindPageIndex(PageTreeHandle *handle, ObjectHandle *page_ref, size_type *result)
Find the 1-based page index for a given page dictionary object.

error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25

size_type
uint32_t size_type
Size type defined in standard library.
Definition c_types.h:62