Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
XrefCompressedEntryHandle Class Reference

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

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

Additional Inherited Members

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

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.

Friends And Related Symbol Documentation

◆ XrefCompressedEntry_GetObjectNumber()

error_type CALLING_CONVENTION XrefCompressedEntry_GetObjectNumber ( XrefCompressedEntryHandle * handle,
biguint_type * result )
related

Get entry object number.

◆ XrefCompressedEntry_GetGenerationNumber()

error_type CALLING_CONVENTION XrefCompressedEntry_GetGenerationNumber ( XrefCompressedEntryHandle * handle,
ushort_type * result )
related

Get entry generation number.

◆ XrefCompressedEntry_InUse()

error_type CALLING_CONVENTION XrefCompressedEntry_InUse ( XrefCompressedEntryHandle * handle,
boolean_type * result )
related

Quick check, if the entry is used or compressed.

◆ XrefCompressedEntry_GetObjectStreamNumber()

error_type CALLING_CONVENTION 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 CALLING_CONVENTION 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

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