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

Stream object represents compressed data inside document. More...

Inheritance diagram for StreamObjectHandle:
ObjectHandle IUnknownHandle
error_type StreamObject_Create (StreamObjectHandle **result)
 Creates a new StreamObject instance.
error_type StreamObject_GetHeader (StreamObjectHandle *handle, DictionaryObjectHandle **result)
 Return streams header dictionary.
error_type StreamObject_SetHeader (StreamObjectHandle *handle, DictionaryObjectHandle *value)
 Set new streams header dictionary.
error_type StreamObject_GetBodyRaw (StreamObjectHandle *handle, BufferHandle **result)
 Get uncompressed stream body. More...
error_type StreamObject_GetBody (StreamObjectHandle *handle, BufferHandle **result)
 Get decompressed stream content.
error_type StreamObject_SetBody (StreamObjectHandle *handle, BufferHandle *value)
 Set new stream content. More...
error_type StreamObject_ToObject (StreamObjectHandle *handle, ObjectHandle **result)
 Reinterpret current object as ObjectHandle.
error_type StreamObject_FromObject (ObjectHandle *handle, StreamObjectHandle **result)
 Convert ObjectHandle to StreamObjectHandle.
error_type StreamObject_Release (StreamObjectHandle *handle)
 Decrement the internal reference counter. More...

Additional Inherited Members

- Public Member Functions inherited from ObjectHandle
error_type Object_GetObjectType (ObjectHandle *handle, ObjectType *result)
 Get derived type of current object.
- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.

Detailed Description

Stream object represents compressed data inside document.


Friends And Related Function Documentation

◆ StreamObject_GetBodyRaw()

error_type StreamObject_GetBodyRaw ( StreamObjectHandle handle,
BufferHandle **  result 

Get uncompressed stream body.

This function is useful when the library cannot decompress or decrypt the stream data.


◆ StreamObject_SetBody()

error_type StreamObject_SetBody ( StreamObjectHandle handle,
BufferHandle value 

Set new stream content.

This sets the decompressed content. Compression is done when the file is saved.

◆ StreamObject_Release()

error_type StreamObject_Release ( StreamObjectHandle handle)

Decrement the internal reference counter.

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

See also

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