Vanilla.PDF  1.5.1
Cross-platform toolkit for creating and modifying PDF documents
List of all members
InputOutputStreamHandle Class Reference

Input stream can read and interpret input from sequences of characters. More...

Inheritance diagram for InputOutputStreamHandle:
InputStreamHandle OutputStreamHandle IUnknownHandle IUnknownHandle IUnknownHandle
error_type InputOutputStream_CreateFromFile (string_type filename, InputOutputStreamHandle **result)
 Opens an existing file at filename for read and write.
 
error_type InputOutputStream_CreateFromMemory (InputOutputStreamHandle **result)
 Creates a memory buffer for data manipulation.
 
error_type InputOutputStream_Read (InputOutputStreamHandle *handle, bigint_type length, char *result, bigint_type *read_length)
 Reads data from input stream and stores them in the resulting array. More...
 
error_type InputOutputStream_ReadBuffer (InputOutputStreamHandle *handle, bigint_type length, BufferHandle **result)
 Reads data from input stream and stores them in the resulting buffer. More...
 
error_type InputOutputStream_GetInputPosition (InputOutputStreamHandle *handle, offset_type *result)
 Gets current offset in the input stream. More...
 
error_type InputOutputStream_SetInputPosition (InputOutputStreamHandle *handle, offset_type value)
 Sets current offset in the input stream. More...
 
error_type InputOutputStream_GetOutputPosition (InputOutputStreamHandle *handle, offset_type *result)
 Gets current offset in the output stream. More...
 
error_type InputOutputStream_SetOutputPosition (InputOutputStreamHandle *handle, offset_type value)
 Sets current offset in the output stream. More...
 
error_type InputOutputStream_WriteString (InputOutputStreamHandle *handle, string_type data)
 Appends null terminated string data to current output stream instance. More...
 
error_type InputOutputStream_WriteBuffer (InputOutputStreamHandle *handle, BufferHandle *data)
 Appends buffer data to current output stream instance. More...
 
error_type InputOutputStream_Flush (InputOutputStreamHandle *handle)
 Flushes all pending data from the stream to it's destination. More...
 
error_type InputOutputStream_ToInputStream (InputOutputStreamHandle *handle, InputStreamHandle **result)
 Reinterpret current object as InputStreamHandle.
 
error_type InputOutputStream_FromInputStream (InputStreamHandle *handle, InputOutputStreamHandle **result)
 Convert InputStreamHandle to InputOutputStreamHandle.
 
error_type InputOutputStream_ToOutputStream (InputOutputStreamHandle *handle, OutputStreamHandle **result)
 Reinterpret current object as OutputStreamHandle.
 
error_type InputOutputStream_FromOutputStream (OutputStreamHandle *handle, InputOutputStreamHandle **result)
 Convert InputStreamHandle to InputOutputStreamHandle.
 
error_type InputOutputStream_ToUnknown (InputOutputStreamHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type InputOutputStream_FromUnknown (IUnknownHandle *handle, InputOutputStreamHandle **result)
 Convert IUnknownHandle to InputOutputStreamHandle.
 
error_type InputOutputStream_Release (InputOutputStreamHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from InputStreamHandle
error_type InputStream_CreateFromFile (string_type filename, InputStreamHandle **result)
 Opens an existing file at filename for read.
 
- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 
- Public Member Functions inherited from OutputStreamHandle
error_type OutputStream_CreateFromFile (string_type filename, OutputStreamHandle **result)
 Creates a new file at filename location and opens it for writing.
 

Detailed Description

Input stream can read and interpret input from sequences of characters.

Examples:
write_custom.c.

Friends And Related Function Documentation

◆ InputOutputStream_Read()

error_type InputOutputStream_Read ( InputOutputStreamHandle handle,
bigint_type  length,
char *  result,
bigint_type read_length 
)
related

Reads data from input stream and stores them in the resulting array.

The allocation and deallocation of the resulting data is responsibility of the caller

◆ InputOutputStream_ReadBuffer()

error_type InputOutputStream_ReadBuffer ( InputOutputStreamHandle handle,
bigint_type  length,
BufferHandle **  result 
)
related

Reads data from input stream and stores them in the resulting buffer.

◆ InputOutputStream_GetInputPosition()

error_type InputOutputStream_GetInputPosition ( InputOutputStreamHandle handle,
offset_type result 
)
related

Gets current offset in the input stream.

◆ InputOutputStream_SetInputPosition()

error_type InputOutputStream_SetInputPosition ( InputOutputStreamHandle handle,
offset_type  value 
)
related

Sets current offset in the input stream.

◆ InputOutputStream_GetOutputPosition()

error_type InputOutputStream_GetOutputPosition ( InputOutputStreamHandle handle,
offset_type result 
)
related

Gets current offset in the output stream.

◆ InputOutputStream_SetOutputPosition()

error_type InputOutputStream_SetOutputPosition ( InputOutputStreamHandle handle,
offset_type  value 
)
related

Sets current offset in the output stream.

◆ InputOutputStream_WriteString()

error_type InputOutputStream_WriteString ( InputOutputStreamHandle handle,
string_type  data 
)
related

Appends null terminated string data to current output stream instance.

◆ InputOutputStream_WriteBuffer()

error_type InputOutputStream_WriteBuffer ( InputOutputStreamHandle handle,
BufferHandle data 
)
related

Appends buffer data to current output stream instance.

◆ InputOutputStream_Flush()

error_type InputOutputStream_Flush ( InputOutputStreamHandle handle)
related

Flushes all pending data from the stream to it's destination.

◆ InputOutputStream_Release()

error_type InputOutputStream_Release ( InputOutputStreamHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release

The documentation for this class was generated from the following file: