XrefUsedEntryHandle Class Reference

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

Inheritance diagram for XrefUsedEntryHandle:

error_type	XrefUsedEntry_GetObjectNumber (XrefEntryHandle *handle, biguint_type *result)
	Get entry object number. More...
error_type	XrefUsedEntry_GetGenerationNumber (XrefEntryHandle *handle, ushort_type *result)
	Get entry generation number. More...
error_type	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	XrefUsedEntry_InUse (XrefUsedEntryHandle *handle, boolean_type *result)
	Quick check, if the entry is used or compressed. More...
error_type	XrefUsedEntry_GetReference (XrefUsedEntryHandle *handle, ObjectHandle **result)
	Get reference to the object represented by this entry.
error_type	XrefUsedEntry_ToEntry (XrefUsedEntryHandle *handle, XrefEntryHandle **result)
	Reinterpret current object as XrefEntryHandle.
error_type	XrefUsedEntry_FromEntry (XrefEntryHandle *handle, XrefUsedEntryHandle **result)
	Convert XrefEntryHandle to XrefUsedEntryHandle.
error_type	XrefUsedEntry_Release (XrefUsedEntryHandle *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...
Related Functions inherited from IUnknownHandle
error_type	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter. More...

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.

Member Function Documentation

XrefUsedEntry_GetObjectNumber()

error_type XrefUsedEntry_GetObjectNumber	(	XrefEntryHandle *	handle,
		biguint_type *	result
	)

Get entry object number.

Friends And Related Function Documentation

XrefUsedEntry_GetGenerationNumber()

error_type XrefUsedEntry_GetGenerationNumber ( XrefEntryHandle *  handle, ushort_type *  result  )

related

Get entry generation number.

XrefUsedEntry_InUse()

error_type XrefUsedEntry_InUse ( XrefUsedEntryHandle *  handle, boolean_type *  result  )

related

Quick check, if the entry is used or compressed.

XrefUsedEntry_Release()

error_type 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

Examples:

extract.c.

---

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

• c_xref.h