This documentation is deprecated and will no longer be updated. Please use the official documentation at vanillapdf.readthedocs.io.
Vanilla.PDF  2.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_destination_name_tree.h
Go to the documentation of this file.
1#ifndef _C_DESTINATION_NAME_TREE_H
2#define _C_DESTINATION_NAME_TREE_H
3
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
50 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_Create(DestinationNameTreeHandle** result);
51
55 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_Contains(DestinationNameTreeHandle* handle, StringObjectHandle* name, boolean_type* result);
56
64 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_Find(DestinationNameTreeHandle* handle, StringObjectHandle* name, DestinationHandle** result);
65
75 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_TryFind(DestinationNameTreeHandle* handle, StringObjectHandle* name, DestinationHandle** result, boolean_type* found);
76
84 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_Insert(DestinationNameTreeHandle* handle, StringObjectHandle* name, DestinationHandle* destination);
85
93 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_Remove(DestinationNameTreeHandle* handle, StringObjectHandle* name, boolean_type* removed);
94
101
105 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_ToUnknown(DestinationNameTreeHandle* handle, IUnknownHandle** result);
106
110 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_FromUnknown(IUnknownHandle* handle, DestinationNameTreeHandle** result);
111
116 VANILLAPDF_API error_type CALLING_CONVENTION DestinationNameTree_Release(DestinationNameTreeHandle* handle);
117
132
140
150
158
163
168
174
177#ifdef __cplusplus
178};
179#endif
180
181#endif /* _C_DESTINATION_NAME_TREE_H */
This file contains macro declarations for importing and exporting symbols from library boundaries.
This file contains all type forward declarations returned by the library API.
This file contains types and constants used as parameters or return values.
Base class for all destinations.
A name tree that maps string names to destination objects. This is the PDF 1.2+ method for storing na...
error_type CALLING_CONVENTION DestinationNameTree_Create(DestinationNameTreeHandle **result)
Create a new empty destination name tree.
error_type CALLING_CONVENTION DestinationNameTree_Remove(DestinationNameTreeHandle *handle, StringObjectHandle *name, boolean_type *removed)
Remove a named destination from the tree.
error_type CALLING_CONVENTION DestinationNameTree_Release(DestinationNameTreeHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION DestinationNameTree_GetIterator(DestinationNameTreeHandle *handle, DestinationNameTreeIteratorHandle **result)
Get an iterator to traverse all named destinations.
error_type CALLING_CONVENTION DestinationNameTree_Find(DestinationNameTreeHandle *handle, StringObjectHandle *name, DestinationHandle **result)
Find a destination by its string name.
error_type CALLING_CONVENTION DestinationNameTree_TryFind(DestinationNameTreeHandle *handle, StringObjectHandle *name, DestinationHandle **result, boolean_type *found)
Try to find a destination by its string name.
error_type CALLING_CONVENTION DestinationNameTree_Contains(DestinationNameTreeHandle *handle, StringObjectHandle *name, boolean_type *result)
Determine if the name tree contains a destination with the given name.
error_type CALLING_CONVENTION DestinationNameTree_Insert(DestinationNameTreeHandle *handle, StringObjectHandle *name, DestinationHandle *destination)
Insert a named destination into the tree.
error_type CALLING_CONVENTION DestinationNameTree_ToUnknown(DestinationNameTreeHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION DestinationNameTree_FromUnknown(IUnknownHandle *handle, DestinationNameTreeHandle **result)
Convert IUnknownHandle to DestinationNameTreeHandle.
Iterator for traversing all entries in a DestinationNameTreeHandle.
error_type CALLING_CONVENTION DestinationNameTreeIterator_IsValid(DestinationNameTreeIteratorHandle *handle, boolean_type *result)
Determine if current position is valid.
error_type CALLING_CONVENTION DestinationNameTreeIterator_GetKey(DestinationNameTreeIteratorHandle *handle, StringObjectHandle **result)
Get the key (name) at the current iterator position.
error_type CALLING_CONVENTION DestinationNameTreeIterator_FromUnknown(IUnknownHandle *handle, DestinationNameTreeIteratorHandle **result)
Convert IUnknownHandle to DestinationNameTreeIteratorHandle.
error_type CALLING_CONVENTION DestinationNameTreeIterator_Release(DestinationNameTreeIteratorHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION DestinationNameTreeIterator_GetValue(DestinationNameTreeIteratorHandle *handle, DestinationHandle **result)
Get the value (destination) at the current iterator position.
error_type CALLING_CONVENTION DestinationNameTreeIterator_ToUnknown(DestinationNameTreeIteratorHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION DestinationNameTreeIterator_Next(DestinationNameTreeIteratorHandle *handle)
Advances iterator to the next position.
Base class for reference counting.
Reprsents human readable text.
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
int8_t boolean_type
Boolean type supported in C.
Definition c_types.h:31