InputStreamHandle Class Reference

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

Inheritance diagram for InputStreamHandle:

error_type CALLING_CONVENTION	InputStream_CreateFromFile (string_type filename, InputStreamHandle **result)
	Opens an existing file at filename for read.
error_type CALLING_CONVENTION	InputStream_CreateFromBuffer (BufferHandle *data, InputStreamHandle **result)
	Reads all data from buffer and stores them for later use.
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.
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 CALLING_CONVENTION	InputStream_ToBuffer (InputStreamHandle *handle, BufferHandle **result)
	Reads all data from the input stream and returns them as a single large buffer.
error_type CALLING_CONVENTION	InputStream_GetInputPosition (InputStreamHandle *handle, offset_type *result)
	Gets current offset in the input stream.
error_type CALLING_CONVENTION	InputStream_SetInputPosition (InputStreamHandle *handle, offset_type value)
	Sets current offset in the input stream.
error_type CALLING_CONVENTION	InputStream_ToUnknown (InputStreamHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	InputStream_FromUnknown (IUnknownHandle *handle, InputStreamHandle **result)
	Convert IUnknownHandle to InputStreamHandle.
error_type CALLING_CONVENTION	InputStream_Release (InputStreamHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

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

Examples

filter.c.

Friends And Related Symbol Documentation

InputStream_CreateFromBuffer()

error_type CALLING_CONVENTION InputStream_CreateFromBuffer ( BufferHandle * data, InputStreamHandle ** result )

related

Reads all data from buffer and stores them for later use.

This method does not reflect buffer updates after it has been called. Only current snapshot of the buffer state is stored in the stream.

InputStream_Read()

error_type CALLING_CONVENTION InputStream_Read ( InputStreamHandle * 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

InputStream_ToBuffer()

error_type CALLING_CONVENTION InputStream_ToBuffer ( InputStreamHandle * handle, BufferHandle ** result )

related

Reads all data from the input stream and returns them as a single large buffer.

This method is not recommended for large files, as the process might not have enough memory.

InputStream_Release()

error_type CALLING_CONVENTION InputStream_Release ( InputStreamHandle * 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:

• c_input_stream.h