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

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

Inheritance diagram for XrefUsedEntryHandle:
XrefEntryHandle IUnknownHandle
error_type XrefUsedEntry_ObjectNumber (XrefEntryHandle *handle, biguint_type *result)
 Get entry object number. More...
error_type XrefUsedEntry_GenerationNumber (XrefEntryHandle *handle, ushort_type *result)
 Get entry generation number. More...
error_type XrefUsedEntry_Offset (XrefUsedEntryHandle *handle, offset_type *result)
 Number of bytes from the beginning of the file to the beginning of the referenced object.
error_type XrefUsedEntry_InUse (XrefUsedEntryHandle *handle, boolean_type *result)
 Quick check, if the entry is used or compressed. More...
error_type XrefUsedEntry_Reference (XrefUsedEntryHandle *handle, ObjectHandle **result)
 Get reference to the object represented by this entry.
error_type XrefUsedEntry_Release (XrefUsedEntryHandle *handle)
 Decrement the internal reference counter. More...

Additional Inherited Members

- Public Member Functions inherited from XrefEntryHandle
error_type XrefEntry_Type (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_ObjectNumber (XrefEntryHandle *handle, biguint_type *result)
 Get entry object number.
error_type XrefEntry_GenerationNumber (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_Release (XrefEntryHandle *handle)
 Decrement the internal reference counter. More...
error_type XrefEntry_ToFreeEntry (XrefEntryHandle *handle, XrefFreeEntryHandle **result)
 Reinterpret entry as XrefFreeEntryHandle.
error_type XrefEntry_ToUsedEntry (XrefEntryHandle *handle, XrefUsedEntryHandle **result)
 Reinterpret entry as XrefUsedEntryHandle.
error_type XrefEntry_ToCompressedEntry (XrefEntryHandle *handle, XrefCompressedEntryHandle **result)
 Reinterpret entry as XrefCompressedEntryHandle.

Detailed Description

Represents used entry within cross-reference section.


Member Function Documentation

◆ XrefUsedEntry_ObjectNumber()

error_type XrefUsedEntry_ObjectNumber ( XrefEntryHandle handle,
biguint_type result 

Get entry object number.

Friends And Related Function Documentation

◆ XrefUsedEntry_GenerationNumber()

error_type XrefUsedEntry_GenerationNumber ( XrefEntryHandle handle,
ushort_type result 

Get entry generation number.

◆ XrefUsedEntry_InUse()

error_type XrefUsedEntry_InUse ( XrefUsedEntryHandle handle,
boolean_type result 

Quick check, if the entry is used or compressed.

◆ XrefUsedEntry_Release()

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