Vanilla.PDF  1.4.1
Cross-platform toolkit for creating and modifying PDF documents
c_document_info.h
Go to the documentation of this file.
1 #ifndef _C_DOCUMENT_INFO_H
2 #define _C_DOCUMENT_INFO_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
31  typedef enum {
38  DocumentTrappedType_Unknown = 0,
39 
45  DocumentTrappedType_True,
46 
50  DocumentTrappedType_False
51  } DocumentTrappedType;
52 
61  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetTitle(DocumentInfoHandle* handle, StringObjectHandle** result);
62 
66  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetAuthor(DocumentInfoHandle* handle, StringObjectHandle** result);
67 
71  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetSubject(DocumentInfoHandle* handle, StringObjectHandle** result);
72 
76  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetKeywords(DocumentInfoHandle* handle, StringObjectHandle** result);
77 
84  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetCreator(DocumentInfoHandle* handle, StringObjectHandle** result);
85 
91  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetProducer(DocumentInfoHandle* handle, StringObjectHandle** result);
92 
96  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetCreationDate(DocumentInfoHandle* handle, DateHandle** result);
97 
101  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetModificationDate(DocumentInfoHandle* handle, DateHandle** result);
102 
106  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_GetTrapped(DocumentInfoHandle* handle, DocumentTrappedType* result);
107 
112  VANILLAPDF_API error_type CALLING_CONVENTION DocumentInfo_Release(DocumentInfoHandle* handle);
113 
116 #ifdef __cplusplus
117 };
118 #endif
119 
120 #endif /* _C_DOCUMENT_INFO_H */
DocumentInfoHandle::DocumentInfo_GetProducer
error_type DocumentInfo_GetProducer(DocumentInfoHandle *handle, StringObjectHandle **result)
If the document was converted to PDF from another format, the name of the conforming product that con...
DocumentInfoHandle::DocumentInfo_GetModificationDate
error_type DocumentInfo_GetModificationDate(DocumentInfoHandle *handle, DateHandle **result)
The date and time the document was most recently modified.
DocumentTrappedType_True
The document has been fully trapped. No further trapping shall be needed.
Definition: c_document_info.h:45
DocumentInfoHandle
Metadata for the document.
DocumentInfoHandle::DocumentInfo_Release
error_type DocumentInfo_Release(DocumentInfoHandle *handle)
Decrement the internal reference counter.
DocumentInfoHandle::DocumentInfo_GetCreator
error_type DocumentInfo_GetCreator(DocumentInfoHandle *handle, StringObjectHandle **result)
If the document was converted to PDF from another format, the name of the conforming product that cre...
c_handles.h
This file contains all type forward declarations returned by the library API.
DocumentInfoHandle::DocumentInfo_GetTrapped
error_type DocumentInfo_GetTrapped(DocumentInfoHandle *handle, DocumentTrappedType *result)
Indication whether the document has been modified to include trapping information (see 14...
DateHandle
Represents a reference to a particular day represented within a calendar system.
DocumentInfoHandle::DocumentInfo_GetCreationDate
error_type DocumentInfo_GetCreationDate(DocumentInfoHandle *handle, DateHandle **result)
The date and time the document was created.
DocumentInfoHandle::DocumentInfo_GetTitle
error_type DocumentInfo_GetTitle(DocumentInfoHandle *handle, StringObjectHandle **result)
The document's title.
DocumentInfoHandle::DocumentInfo_GetSubject
error_type DocumentInfo_GetSubject(DocumentInfoHandle *handle, StringObjectHandle **result)
The subject of the document.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
DocumentTrappedType
DocumentTrappedType
Indication whether the document has been modified to include trapping information (see 14...
Definition: c_document_info.h:31
DocumentTrappedType_Unknown
Either it is unknown whether the document has been trapped or it has been partly but not yet fully tr...
Definition: c_document_info.h:38
c_values.h
This file contains types and constants used as parameters or return values.
DocumentTrappedType_False
The document has not yet been trapped.
Definition: c_document_info.h:50
StringObjectHandle
Reprsents human readable text.
DocumentInfoHandle::DocumentInfo_GetAuthor
error_type DocumentInfo_GetAuthor(DocumentInfoHandle *handle, StringObjectHandle **result)
The name of the person who created the document.
DocumentInfoHandle::DocumentInfo_GetKeywords
error_type DocumentInfo_GetKeywords(DocumentInfoHandle *handle, StringObjectHandle **result)
Keywords associated with the document.