Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_file.h
Go to the documentation of this file.
1 #ifndef _C_FILE_H
2 #define _C_FILE_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 
48  VANILLAPDF_API error_type CALLING_CONVENTION File_Open(string_type filename, FileHandle** result);
49 
55  VANILLAPDF_API error_type CALLING_CONVENTION File_Create(string_type filename, FileHandle** result);
56 
62  VANILLAPDF_API error_type CALLING_CONVENTION File_Initialize(FileHandle* handle);
63 
69  VANILLAPDF_API error_type CALLING_CONVENTION File_IsEncrypted(FileHandle* handle, boolean_type* result);
70 
74  VANILLAPDF_API error_type CALLING_CONVENTION File_SetEncryptionPassword(FileHandle* handle, string_type password);
75 
82  VANILLAPDF_API error_type CALLING_CONVENTION File_SetEncryptionKey(FileHandle* handle, EncryptionKeyHandle* key);
83 
87  VANILLAPDF_API error_type CALLING_CONVENTION File_XrefChain(FileHandle* handle, XrefChainHandle** result);
88 
92  VANILLAPDF_API error_type CALLING_CONVENTION File_GetIndirectObject(FileHandle* handle, biguint_type obj_number, ushort_type gen_number, ObjectHandle** result);
93 
98  VANILLAPDF_API error_type CALLING_CONVENTION File_Release(FileHandle* handle);
99 
102 #ifdef __cplusplus
103 };
104 #endif
105 
106 #endif /* _C_FILE_H */
error_type File_Create(string_type filename, FileHandle **result)
Creates a file for writing.
uint16_t ushort_type
16-bit unsigned integer
Definition: c_types.h:46
error_type File_IsEncrypted(FileHandle *handle, boolean_type *result)
Determine if file is encrypted.
error_type File_XrefChain(FileHandle *handle, XrefChainHandle **result)
Get chain of xref tables for iteration.
Represents collection of XrefHandle.
error_type File_SetEncryptionKey(FileHandle *handle, EncryptionKeyHandle *key)
Set files encryption key.
uint64_t biguint_type
64-bit unsigned integer type
Definition: c_types.h:77
error_type File_Open(string_type filename, FileHandle **result)
Opens a file for reading.
This file contains all type forward declarations returned by the library API.
const char * string_type
C-Style string.
Definition: c_types.h:82
Base class for syntactic tokens.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
error_type File_GetIndirectObject(FileHandle *handle, biguint_type obj_number, ushort_type gen_number, ObjectHandle **result)
Find exact object within all xref tables.
This file contains macro declarations for importing and exporting symbols from library boundaries...
Represents encryption key other than password.
This file contains types and constants used as parameters or return values.
Represents low-level file access handle.
error_type File_Initialize(FileHandle *handle)
Perform basic intialization.
error_type File_Release(FileHandle *handle)
Decrement the internal reference counter.
error_type File_SetEncryptionPassword(FileHandle *handle, string_type password)
Set encryption password.
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31