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

Represents compressed entry within cross-reference section. More...

Inheritance diagram for XrefCompressedEntryHandle:
XrefEntryHandle IUnknownHandle
error_type XrefCompressedEntry_GetObjectNumber (XrefEntryHandle *handle, biguint_type *result)
 Get entry object number. More...
 
error_type XrefCompressedEntry_GetGenerationNumber (XrefEntryHandle *handle, ushort_type *result)
 Get entry generation number. More...
 
error_type XrefCompressedEntry_InUse (XrefCompressedEntryHandle *handle, boolean_type *result)
 Quick check, if the entry is used or compressed. More...
 
error_type XrefCompressedEntry_GetReference (XrefCompressedEntryHandle *handle, ObjectHandle **result)
 Get reference to the object represented by this entry.
 
error_type XrefCompressedEntry_GetIndex (XrefCompressedEntryHandle *handle, size_type *result)
 The index of this object within the object stream.
 
error_type XrefCompressedEntry_GetObjectStreamNumber (XrefCompressedEntryHandle *handle, biguint_type *result)
 The object number of the object stream in which this object is stored. More...
 
error_type XrefCompressedEntry_ToEntry (XrefCompressedEntryHandle *handle, XrefEntryHandle **result)
 Reinterpret current object as XrefEntryHandle.
 
error_type XrefCompressedEntry_FromEntry (XrefEntryHandle *handle, XrefCompressedEntryHandle **result)
 Convert XrefEntryHandle to XrefUsedEntryHandle.
 
error_type XrefCompressedEntry_Release (XrefCompressedEntryHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from XrefEntryHandle
error_type XrefEntry_GetType (XrefEntryHandle *handle, XrefEntryType *result)
 Get entry type.
 
- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 
- Related Functions inherited from XrefEntryHandle
error_type XrefEntry_GetObjectNumber (XrefEntryHandle *handle, biguint_type *result)
 Get entry object number.
 
error_type XrefEntry_GetGenerationNumber (XrefEntryHandle *handle, ushort_type *result)
 Get entry generation number.
 
error_type XrefEntry_InUse (XrefEntryHandle *handle, boolean_type *result)
 Quick check, if the entry is used or compressed.
 
error_type XrefEntry_ToUnknown (XrefEntryHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type XrefEntry_FromUnknown (IUnknownHandle *handle, XrefEntryHandle **result)
 Convert IUnknownHandle to XrefEntryHandle.
 
error_type XrefEntry_Release (XrefEntryHandle *handle)
 Decrement the internal reference counter. More...
 

Detailed Description

Represents compressed entry within cross-reference section.

Compressed entry means that the object is located within (7.5.7 Object streams) compressed object stream. This entry type can be only found in cross-reference streams.

Examples:
extract.c.

Member Function Documentation

◆ XrefCompressedEntry_GetObjectNumber()

error_type XrefCompressedEntry_GetObjectNumber ( XrefEntryHandle handle,
biguint_type result 
)

Get entry object number.

Friends And Related Function Documentation

◆ XrefCompressedEntry_GetGenerationNumber()

error_type XrefCompressedEntry_GetGenerationNumber ( XrefEntryHandle handle,
ushort_type result 
)
related

Get entry generation number.

◆ XrefCompressedEntry_InUse()

error_type XrefCompressedEntry_InUse ( XrefCompressedEntryHandle handle,
boolean_type result 
)
related

Quick check, if the entry is used or compressed.

◆ XrefCompressedEntry_GetObjectStreamNumber()

error_type XrefCompressedEntry_GetObjectStreamNumber ( XrefCompressedEntryHandle handle,
biguint_type result 
)
related

The object number of the object stream in which this object is stored.

The generation number of the object stream shall be implicitly 0.

◆ XrefCompressedEntry_Release()

error_type XrefCompressedEntry_Release ( XrefCompressedEntryHandle 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
Examples:
extract.c.

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