Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
c_input_stream.h
Go to the documentation of this file.
1#ifndef _C_INPUT_STREAM_INTERFACE_H
2#define _C_INPUT_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
9extern "C"
10{
11#endif
12
33 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_CreateFromFile(string_type filename, InputStreamHandle** result);
34
40 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_CreateFromBuffer(BufferHandle* data, InputStreamHandle** result);
41
46 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_Read(InputStreamHandle* handle, bigint_type length, char* result, bigint_type* read_length);
47
51 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_ReadBuffer(InputStreamHandle* handle, bigint_type length, BufferHandle** result);
52
57 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_ToBuffer(InputStreamHandle* handle, BufferHandle** result);
58
62 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_GetInputPosition(InputStreamHandle* handle, offset_type* result);
63
67 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_SetInputPosition(InputStreamHandle* handle, offset_type value);
68
72 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_ToUnknown(InputStreamHandle* handle, IUnknownHandle** result);
73
77 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_FromUnknown(IUnknownHandle* handle, InputStreamHandle** result);
78
83 VANILLAPDF_API error_type CALLING_CONVENTION InputStream_Release(InputStreamHandle* handle);
84
87#ifdef __cplusplus
88};
89#endif
90
91#endif /* _C_INPUT_STREAM_INTERFACE_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.
BufferHandle
Represents memory stored data.
IUnknownHandle
Base class for reference counting.
InputStreamHandle
Input stream can read and interpret input from sequences of characters.
InputStreamHandle::InputStream_ToUnknown
error_type CALLING_CONVENTION InputStream_ToUnknown(InputStreamHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
InputStreamHandle::InputStream_GetInputPosition
error_type CALLING_CONVENTION InputStream_GetInputPosition(InputStreamHandle *handle, offset_type *result)
Gets current offset in the input stream.
InputStreamHandle::InputStream_CreateFromBuffer
error_type CALLING_CONVENTION InputStream_CreateFromBuffer(BufferHandle *data, InputStreamHandle **result)
Reads all data from buffer and stores them for later use.
InputStreamHandle::InputStream_ToBuffer
error_type CALLING_CONVENTION InputStream_ToBuffer(InputStreamHandle *handle, BufferHandle **result)
Reads all data from the input stream and returns them as a single large buffer.
InputStreamHandle::InputStream_FromUnknown
error_type CALLING_CONVENTION InputStream_FromUnknown(IUnknownHandle *handle, InputStreamHandle **result)
Convert IUnknownHandle to InputStreamHandle.
InputStreamHandle::InputStream_Read
error_type CALLING_CONVENTION InputStream_Read(InputStreamHandle *handle, bigint_type length, char *result, bigint_type *read_length)
Reads data from input stream and stores them in the resulting array.
InputStreamHandle::InputStream_Release
error_type CALLING_CONVENTION InputStream_Release(InputStreamHandle *handle)
Decrement the internal reference counter.
InputStreamHandle::InputStream_SetInputPosition
error_type CALLING_CONVENTION InputStream_SetInputPosition(InputStreamHandle *handle, offset_type value)
Sets current offset in the input stream.
InputStreamHandle::InputStream_CreateFromFile
error_type CALLING_CONVENTION InputStream_CreateFromFile(string_type filename, InputStreamHandle **result)
Opens an existing file at filename for read.
InputStreamHandle::InputStream_ReadBuffer
error_type CALLING_CONVENTION InputStream_ReadBuffer(InputStreamHandle *handle, bigint_type length, BufferHandle **result)
Reads data from input stream and stores them in the resulting buffer.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
offset_type
int64_t offset_type
Offset type compatible with standard IO.
Definition c_types.h:56
bigint_type
int64_t bigint_type
64-bit signed integer type
Definition c_types.h:72
string_type
const char * string_type
C-Style string.
Definition c_types.h:82