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_name_dictionary.h
Go to the documentation of this file.
1#ifndef _C_NAME_DICTIONARY_H
2#define _C_NAME_DICTIONARY_H
3
4#include "vanillapdf/c_export.h"
5#include "vanillapdf/c_handles.h"
6#include "vanillapdf/c_values.h"
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
40 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_Create(NameDictionaryHandle** result);
41
45 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_ContainsDestinations(NameDictionaryHandle* handle, boolean_type* result);
46
55 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_GetDestinations(NameDictionaryHandle* handle, DestinationNameTreeHandle** result);
56
62 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_SetDestinations(NameDictionaryHandle* handle, DestinationNameTreeHandle* destinations);
63
67 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_ToUnknown(NameDictionaryHandle* handle, IUnknownHandle** result);
68
72 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_FromUnknown(IUnknownHandle* handle, NameDictionaryHandle** result);
73
78 VANILLAPDF_API error_type CALLING_CONVENTION NameDictionary_Release(NameDictionaryHandle* handle);
79
82#ifdef __cplusplus
83};
84#endif
85
86#endif /* _C_NAME_DICTIONARY_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.
DestinationNameTreeHandle
A name tree that maps string names to destination objects. This is the PDF 1.2+ method for storing na...
IUnknownHandle
Base class for reference counting.
NameDictionaryHandle
The name dictionary (PDF 1.2+) associates names with various document objects using name trees for ef...
NameDictionaryHandle::NameDictionary_ToUnknown
error_type CALLING_CONVENTION NameDictionary_ToUnknown(NameDictionaryHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
NameDictionaryHandle::NameDictionary_ContainsDestinations
error_type CALLING_CONVENTION NameDictionary_ContainsDestinations(NameDictionaryHandle *handle, boolean_type *result)
Check if the name dictionary contains a Dests name tree.
NameDictionaryHandle::NameDictionary_FromUnknown
error_type CALLING_CONVENTION NameDictionary_FromUnknown(IUnknownHandle *handle, NameDictionaryHandle **result)
Convert IUnknownHandle to NameDictionaryHandle.
NameDictionaryHandle::NameDictionary_Release
error_type CALLING_CONVENTION NameDictionary_Release(NameDictionaryHandle *handle)
Decrement the internal reference counter.
NameDictionaryHandle::NameDictionary_Create
error_type CALLING_CONVENTION NameDictionary_Create(NameDictionaryHandle **result)
Create a new empty name dictionary.
NameDictionaryHandle::NameDictionary_SetDestinations
error_type CALLING_CONVENTION NameDictionary_SetDestinations(NameDictionaryHandle *handle, DestinationNameTreeHandle *destinations)
Set the Dests name tree in the name dictionary.
NameDictionaryHandle::NameDictionary_GetDestinations
error_type CALLING_CONVENTION NameDictionary_GetDestinations(NameDictionaryHandle *handle, DestinationNameTreeHandle **result)
Get the Dests name tree from the name dictionary.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
boolean_type
int8_t boolean_type
Boolean type supported in C.
Definition c_types.h:31