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

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

Inheritance diagram for XrefUsedEntryHandle:
XrefEntryHandle IUnknownHandle
error_type CALLING_CONVENTION XrefUsedEntry_Create (biguint_type object_number, ushort_type generation_number, offset_type offset, XrefUsedEntryHandle **result)
 Creates a new instance.
 
error_type CALLING_CONVENTION XrefUsedEntry_GetObjectNumber (XrefUsedEntryHandle *handle, biguint_type *result)
 Get entry object number.
 
error_type CALLING_CONVENTION XrefUsedEntry_GetGenerationNumber (XrefUsedEntryHandle *handle, ushort_type *result)
 Get entry generation number.
 
error_type CALLING_CONVENTION XrefUsedEntry_GetOffset (XrefUsedEntryHandle *handle, offset_type *result)
 Number of bytes from the beginning of the file to the beginning of the referenced object.
 
error_type CALLING_CONVENTION XrefUsedEntry_InUse (XrefUsedEntryHandle *handle, boolean_type *result)
 Quick check, if the entry is used or compressed.
 
error_type CALLING_CONVENTION XrefUsedEntry_GetReference (XrefUsedEntryHandle *handle, ObjectHandle **result)
 Get reference to the object represented by this entry.
 
error_type CALLING_CONVENTION XrefUsedEntry_SetReference (XrefUsedEntryHandle *handle, ObjectHandle *data)
 Set reference to the object represented by this entry.
 
error_type CALLING_CONVENTION XrefUsedEntry_ToEntry (XrefUsedEntryHandle *handle, XrefEntryHandle **result)
 Reinterpret current object as XrefEntryHandle.
 
error_type CALLING_CONVENTION XrefUsedEntry_FromEntry (XrefEntryHandle *handle, XrefUsedEntryHandle **result)
 Convert XrefEntryHandle to XrefUsedEntryHandle.
 
error_type CALLING_CONVENTION XrefUsedEntry_Release (XrefUsedEntryHandle *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 used entry within cross-reference section.

Used entry means that an indirect object is allocated within the PDF file and this entry points to it's offset.

Examples
extract.c.

Friends And Related Symbol Documentation

◆ XrefUsedEntry_GetObjectNumber()

error_type CALLING_CONVENTION XrefUsedEntry_GetObjectNumber ( XrefUsedEntryHandle * handle,
biguint_type * result )
related

Get entry object number.

◆ XrefUsedEntry_GetGenerationNumber()

error_type CALLING_CONVENTION XrefUsedEntry_GetGenerationNumber ( XrefUsedEntryHandle * handle,
ushort_type * result )
related

Get entry generation number.

◆ XrefUsedEntry_InUse()

error_type CALLING_CONVENTION XrefUsedEntry_InUse ( XrefUsedEntryHandle * handle,
boolean_type * result )
related

Quick check, if the entry is used or compressed.

◆ XrefUsedEntry_Release()

error_type CALLING_CONVENTION XrefUsedEntry_Release ( XrefUsedEntryHandle * 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: