Vanilla.PDF  1.4.1
Cross-platform toolkit for creating and modifying PDF documents
c_output_stream.h
Go to the documentation of this file.
1 #ifndef _C_OUTPUT_STREAM_INTERFACE_H
2 #define _C_OUTPUT_STREAM_INTERFACE_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 
33  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_CreateFromFile(string_type filename, OutputStreamHandle** result);
34 
38  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_GetOutputPosition(OutputStreamHandle* handle, offset_type* result);
39 
43  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_SetOutputPosition(OutputStreamHandle* handle, offset_type value);
44 
48  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_WriteString(OutputStreamHandle* handle, string_type data);
49 
53  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_WriteBuffer(OutputStreamHandle* handle, BufferHandle* data);
54 
58  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_Flush(OutputStreamHandle* handle);
59 
63  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_ToUnknown(OutputStreamHandle* handle, IUnknownHandle** result);
64 
68  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_FromUnknown(IUnknownHandle* handle, OutputStreamHandle** result);
69 
74  VANILLAPDF_API error_type CALLING_CONVENTION OutputStream_Release(OutputStreamHandle* handle);
75 
78 #ifdef __cplusplus
79 };
80 #endif
81 
82 #endif /* _C_OUTPUT_STREAM_INTERFACE_H */
OutputStreamHandle
Output stream can write sequences of characters and represent other kinds of data.
OutputStreamHandle::OutputStream_Flush
error_type OutputStream_Flush(OutputStreamHandle *handle)
Flushes all pending data from the stream to it's destination.
OutputStreamHandle::OutputStream_Release
error_type OutputStream_Release(OutputStreamHandle *handle)
Decrement the internal reference counter.
c_handles.h
This file contains all type forward declarations returned by the library API.
string_type
const char * string_type
C-Style string.
Definition: c_types.h:82
OutputStreamHandle::OutputStream_GetOutputPosition
error_type OutputStream_GetOutputPosition(OutputStreamHandle *handle, offset_type *result)
Gets current offset in the output stream.
OutputStreamHandle::OutputStream_ToUnknown
error_type OutputStream_ToUnknown(OutputStreamHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
OutputStreamHandle::OutputStream_FromUnknown
error_type OutputStream_FromUnknown(IUnknownHandle *handle, OutputStreamHandle **result)
Convert IUnknownHandle to OutputStreamHandle.
OutputStreamHandle::OutputStream_SetOutputPosition
error_type OutputStream_SetOutputPosition(OutputStreamHandle *handle, offset_type value)
Sets current offset in the output stream.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
OutputStreamHandle::OutputStream_WriteString
error_type OutputStream_WriteString(OutputStreamHandle *handle, string_type data)
Appends null terminated string to current output stream instance.
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
c_values.h
This file contains types and constants used as parameters or return values.
offset_type
int64_t offset_type
Offset type compatible with standard IO.
Definition: c_types.h:56
BufferHandle
Represents memory stored data.
IUnknownHandle
Base class for reference counting.
OutputStreamHandle::OutputStream_CreateFromFile
error_type OutputStream_CreateFromFile(string_type filename, OutputStreamHandle **result)
Creates a new file at filename location and opens it for writing.
OutputStreamHandle::OutputStream_WriteBuffer
error_type OutputStream_WriteBuffer(OutputStreamHandle *handle, BufferHandle *data)
Appends buffer string to current output stream instance.