Files 

class FileStructureIssueHandle : public IUnknownHandle 

#include <c_file_structure_validator.h>

Represents a single structural issue found during validation.

Unnamed Group

error_type FileStructureIssue_GetSeverity(FileStructureIssueHandle *handle, FileStructureIssueSeverityType *result): Get the severity of the issue.

error_type FileStructureIssue_GetCode(FileStructureIssueHandle *handle, FileStructureIssueCodeType *result): Get the issue code.

error_type FileStructureIssue_GetMessage(FileStructureIssueHandle *handle, BufferHandle **result): Get the human-readable issue message.

error_type FileStructureIssue_HasObjectContext(FileStructureIssueHandle *handle, boolean_type *result): Check whether this issue carries an object context (object and generation number).

Note

Call this before FileStructureIssue_GetObjectNumber or FileStructureIssue_GetGenerationNumber. File-level issues have no object context.

error_type FileStructureIssue_GetObjectNumber(FileStructureIssueHandle *handle, biguint_type *result): Get the object number associated with this issue.

Note

Returns VANILLAPDF_ERROR_OBJECT_MISSING if the issue has no object context. Check FileStructureIssue_HasObjectContext first.

error_type FileStructureIssue_GetGenerationNumber(FileStructureIssueHandle *handle, ushort_type *result): Get the generation number associated with this issue.

Note

Returns VANILLAPDF_ERROR_OBJECT_MISSING if the issue has no object context. Check FileStructureIssue_HasObjectContext first.

error_type FileStructureIssue_ToUnknown(FileStructureIssueHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type FileStructureIssue_FromUnknown(IUnknownHandle *handle, FileStructureIssueHandle **result): Convert IUnknownHandle to FileStructureIssueHandle.

error_type FileStructureIssue_Release(FileStructureIssueHandle *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

class FileStructureValidationResultHandle : public IUnknownHandle 

#include <c_file_structure_validator.h>

Container for all issues found during file structure validation.

Unnamed Group

error_type FileStructureValidationResult_GetIssueCount(FileStructureValidationResultHandle *handle, size_type *result): Get the total number of issues found.

error_type FileStructureValidationResult_GetIssueAt(FileStructureValidationResultHandle *handle, size_type index, FileStructureIssueHandle **result): Get an issue at the specified index.

error_type FileStructureValidationResult_IsValid(FileStructureValidationResultHandle *handle, boolean_type *result): Check if the file is structurally valid (no errors).

error_type FileStructureValidationResult_GetErrorCount(FileStructureValidationResultHandle *handle, size_type *result): Get the number of error-severity issues.

error_type FileStructureValidationResult_GetWarningCount(FileStructureValidationResultHandle *handle, size_type *result): Get the number of warning-severity issues.

error_type FileStructureValidationResult_ToUnknown(FileStructureValidationResultHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type FileStructureValidationResult_FromUnknown(IUnknownHandle *handle, FileStructureValidationResultHandle **result): Convert IUnknownHandle to FileStructureValidationResultHandle.

error_type FileStructureValidationResult_Release(FileStructureValidationResultHandle *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

class FileStructureValidator

#include <c_file_structure_validator.h>

Static utility class for validating PDF file structure.

In practice, initialization is resilient: when the primary xref parsing fails, the parser falls back to a full-file object scan (FindAllObjects), which recovers most malformed files. Only files that fail even the fallback (e.g. those using unsupported features such as unknown encryption) cannot be initialized and therefore cannot be validated. For those cases the initialization error itself is the diagnostic signal.

Note

This validator operates on the in-memory structures produced by File_Initialize. It requires the file to be successfully initialized before validation can run.

Unnamed Group

error_type FileStructureValidator_Validate(FileHandle *handle, FileStructureValidationResultHandle **result)

Validate the structure of an initialized PDF file.

Parameters:

handle – An initialized file handle
result – Output validation result

class FileWriterHandle : public IUnknownHandle 

#include <c_file_writer.h>

Implements serialization of Files to destination stream.

Unnamed Group

error_type FileWriter_Create(FileWriterHandle **result): Create new FileWriter instance.

error_type FileWriter_Write(FileWriterHandle *handle, FileHandle *source, FileHandle *destination)

Save file state into new destination.

Destination file will be overwritten if it exists.

error_type FileWriter_WriteIncremental(FileWriterHandle *handle, FileHandle *source, FileHandle *destination)

Save file state into new destination and create new section for all modifications done by user.

This method creates a new section with all modified objects. Whole file content preceeding new section will be preserved.

error_type FileWriter_Subscribe(FileWriterHandle *handle, FileWriterObserverHandle *observer): Subscribe a new observer to the file writer events.

error_type FileWriter_Unsubscribe(FileWriterHandle *handle, FileWriterObserverHandle *observer): Unsubscribe existing observer from the file writer events.

error_type FileWriter_ToUnknown(FileWriterHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type FileWriter_FromUnknown(IUnknownHandle *handle, FileWriterHandle **result): Convert IUnknownHandle to FileWriterHandle.

error_type FileWriter_Release(FileWriterHandle *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

class FileWriterObserverHandle : public IUnknownHandle 

#include <c_file_writer_observer.h>

Allows hooking on FileWriterHandle events.

Unnamed Group

typedef error_type (*FileWriterObserver_OnInitializing_Function)(void *user_data, InputOutputStreamHandle *output_stream): The first operation of the FileWriter.

typedef error_type (*FileWriterObserver_OnFinalizing_Function)(void *user_data, InputOutputStreamHandle *output_stream): The last operation of the FileWriter.

typedef error_type (*FileWriterObserver_OnBeforeObjectWrite_Function)(void *user_data, ObjectHandle *object): Invoked before every single object is written to the destination file.

typedef error_type (*FileWriterObserver_OnAfterObjectWrite_Function)(void *user_data, ObjectHandle *object): Invoked after every single object is written to the destination file.

typedef error_type (*FileWriterObserver_OnBeforeObjectOffsetRecalculation_Function)(void *user_data, ObjectHandle *object): Invoked before new object offset is recalculated.

typedef error_type (*FileWriterObserver_OnAfterObjectOffsetRecalculation_Function)(void *user_data, ObjectHandle *object): Invoked after new object offset is recalculated.

typedef error_type (*FileWriterObserver_OnBeforeEntryOffsetRecalculation_Function)(void *user_data, XrefEntryHandle *entry): Invoked before xref entry offset is recalculated.

typedef error_type (*FileWriterObserver_OnAfterEntryOffsetRecalculation_Function)(void *user_data, XrefEntryHandle *entry): Invoked after xref entry offset is recalculated.

typedef error_type (*FileWriterObserver_OnBeforeOutputFlush_Function)(void *user_data, InputOutputStreamHandle *output_stream): Invoked before the destination stream is flushed.

typedef error_type (*FileWriterObserver_OnAfterOutputFlush_Function)(void *user_data, InputOutputStreamHandle *output_stream): Invoked after the destination stream is flushed.

Create a new FileWriterObserverHandle instance with custom callbacks.

Callbacks can be set to NULL, if there is no action associated with them

error_type FileWriterObserver_ToUnknown(FileWriterObserverHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type FileWriterObserver_FromUnknown(IUnknownHandle *handle, FileWriterObserverHandle **result): Convert IUnknownHandle to FileWriterObserverHandle.

error_type FileWriterObserver_Release(FileWriterObserverHandle *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

class FilterBaseHandle : public IUnknownHandle 

#include <c_filter.h>

Base class for all compression filters.

Subclassed by ASCII85DecodeFilterHandle, ASCIIHexDecodeFilterHandle, DCTDecodeFilterHandle, FlateDecodeFilterHandle, JPXDecodeFilterHandle, LZWDecodeFilterHandle

Unnamed Group

error_type FilterBase_Encode(FilterBaseHandle *handle, BufferHandle *data, BufferHandle **result): Encodes source data and returns encoded result data.

error_type FilterBase_EncodeParams(FilterBaseHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result): Encodes source data with specified params and returns encoded result data.

error_type FilterBase_Decode(FilterBaseHandle *handle, BufferHandle *data, BufferHandle **result): Decodes source data and returns decoded result data.

error_type FilterBase_ToUnknown(FilterBaseHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type FilterBase_FromUnknown(IUnknownHandle *handle, FilterBaseHandle **result): Convert IUnknownHandle to FilterBaseHandle.

error_type FilterBase_Release(FilterBaseHandle *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

section 7.4.4 - LZWDecode and FlateDecode Filters

class FlateDecodeFilterHandle : public FilterBaseHandle 

#include <c_filter.h>

The Flate method is based on the public-domain zlib/deflate compression method.

It is fully defined in Internet RFC 1950 - ZLIB Compressed Data Format Specification, and RFC 1951 DEFLATE Compressed Data Format Specification

.

For more information please visit

Unnamed Group

error_type FlateDecodeFilter_Create(FlateDecodeFilterHandle **result): Creates a new filter instance.

error_type FlateDecodeFilter_Encode(FlateDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type FlateDecodeFilter_EncodeParams(FlateDecodeFilterHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type FlateDecodeFilter_Decode(FlateDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Decodes source data and returns decoded result data.

See also

error_type FlateDecodeFilter_Release(FlateDecodeFilterHandle *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

section 7.4.8 - DCTDecode Filter

class DCTDecodeFilterHandle : public FilterBaseHandle 

#include <c_filter.h>

The DCTDecode filter decodes grayscale or colour image data that has been encoded in the JPEG baseline format.

See Adobe Technical Note #5116 for additional information about the use of JPEG “markers”.

For more information please visit

Unnamed Group

error_type DCTDecodeFilter_Create(DCTDecodeFilterHandle **result): Creates a new filter instance.

error_type DCTDecodeFilter_Encode(DCTDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type DCTDecodeFilter_EncodeParams(DCTDecodeFilterHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type DCTDecodeFilter_Decode(DCTDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Decodes source data and returns decoded result data.

See also

error_type DCTDecodeFilter_Release(DCTDecodeFilterHandle *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

class ASCII85DecodeFilterHandle : public FilterBaseHandle 

#include <c_filter.h>

The ASCII85Decode filter decodes data that has been encoded in ASCII base-85 encoding and produces binary data.

For more information please visit section 7.4.3 - ASCII85Decode Filter>

Unnamed Group

error_type ASCII85DecodeFilter_Create(ASCII85DecodeFilterHandle **result): Creates a new filter instance.

error_type ASCII85DecodeFilter_Encode(ASCII85DecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type ASCII85DecodeFilter_EncodeParams(ASCII85DecodeFilterHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type ASCII85DecodeFilter_Decode(ASCII85DecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Decodes source data and returns decoded result data.

See also

error_type ASCII85DecodeFilter_Release(ASCII85DecodeFilterHandle *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

section 7.4.2 - ASCIIHexDecode Filter

class ASCIIHexDecodeFilterHandle : public FilterBaseHandle 

#include <c_filter.h>

The ASCIIHexDecode filter decodes data that has been encoded in ASCII hexadecimal form.

ASCII hexadecimal encoding and ASCII base-85 encoding

convert binary data, such as image data or previously compressed data, to 7-bit ASCII characters.

For more information please visit

Unnamed Group

error_type ASCIIHexDecodeFilter_Create(ASCIIHexDecodeFilterHandle **result): Creates a new filter instance.

error_type ASCIIHexDecodeFilter_Encode(ASCIIHexDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type ASCIIHexDecodeFilter_EncodeParams(ASCIIHexDecodeFilterHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type ASCIIHexDecodeFilter_Decode(ASCIIHexDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Decodes source data and returns decoded result data.

See also

error_type ASCIIHexDecodeFilter_Release(ASCIIHexDecodeFilterHandle *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

class LZWDecodeFilterHandle : public FilterBaseHandle 

#include <c_filter.h>

LZW (Lempel-Ziv-Welch) is a variable-length, adaptive compression method that has been adopted as one of the standard compression methods in the Tag Image File Format (TIFF) standard.

For details on LZW encoding see 7.4.4.2, “Details of LZW Encoding.”

Unnamed Group

error_type LZWDecodeFilter_Create(LZWDecodeFilterHandle **result): Creates a new filter instance.

error_type LZWDecodeFilter_Encode(LZWDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type LZWDecodeFilter_EncodeParams(LZWDecodeFilterHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type LZWDecodeFilter_Decode(LZWDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Decodes source data and returns decoded result data.

See also

error_type LZWDecodeFilter_Release(LZWDecodeFilterHandle *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

class JPXDecodeFilterHandle : public FilterBaseHandle 

#include <c_filter.h>

The JPXDecode filter (PDF 1.5) decodes data that has been encoded using the JPEG2000 compression method, an ISO standard for the compression and packaging of image data.

Unnamed Group

error_type JPXDecodeFilter_Create(JPXDecodeFilterHandle **result): Creates a new filter instance.

error_type JPXDecodeFilter_Encode(JPXDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type JPXDecodeFilter_EncodeParams(JPXDecodeFilterHandle *handle, BufferHandle *data, DictionaryObjectHandle *parameters, BufferHandle **result)

Encodes source data and returns encoded result data.

See also

error_type JPXDecodeFilter_Decode(JPXDecodeFilterHandle *handle, BufferHandle *data, BufferHandle **result)

Decodes source data and returns decoded result data.

See also

error_type JPXDecodeFilter_Release(JPXDecodeFilterHandle *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

IndirectReferenceObjectHandle

Note

FileStructureValidator initialization requirement

FileStructureValidator_Validate requires the file to have been successfully initialized via File_Initialize before validation can run. In practice this is less restrictive than it sounds: when the primary xref parsing fails, the parser falls back to a full-file object scan that recovers most malformed PDFs, and only then is the file marked as initialized. Files that still cannot be initialized after the fallback — typically those using unsupported features such as unknown encryption — will propagate an initialization error instead; in those cases the error from File_Initialize is itself the diagnostic signal.

Objects

enum ObjectType

Derived types of ObjectHandle.

Values:

enumerator ObjectType_Undefined: Undefined unitialized default value, triggers error when used.

enumerator ObjectType_Null

The null object has a type and value that are unequal to those of any other object.

See also

NullObjectHandle

enumerator ObjectType_Array

An array object is a one-dimensional collection of objects arranged sequentially.

See also

ArrayObjectHandle

enumerator ObjectType_Boolean

Boolean objects represent the logical values of true and false.

See also

BooleanObjectHandle

enumerator ObjectType_Dictionary

A dictionary object is an associative table containing pairs of objects.

See also

DictionaryObjectHandle

enumerator ObjectType_Integer

Integer objects represent mathematical integers.

See also

IntegerObjectHandle

enumerator ObjectType_Name

A name object is an atomic symbol uniquely defined by a sequence of characters.

See also

NameObjectHandle

enumerator ObjectType_Real

Real objects represent mathematical real numbers.

See also

RealObjectHandle

enumerator ObjectType_Stream

Stream object represents compressed data inside document.

See also

StreamObjectHandle

enumerator ObjectType_String

Reprsents human readable text.

See also

StringObjectHandle

enumerator ObjectType_IndirectReference

Represents reference to another object.

See also

enum ObjectAttributeType

Derived types of BaseObjectAttributeHandle.

Values:

enumerator ObjectAttributeType_Undefined: Undefined unitialized default value, triggers error when used.

enumerator ObjectAttributeType_Empty

enumerator ObjectAttributeType_SerializationOverride

enumerator ObjectAttributeType_TrackingIdentifier

enumerator ObjectAttributeType_ImageMetadata

enum ImageColorSpaceType

Image color spaces used within ImageMetadataObjectAttributeHandle.

Values:

enumerator ImageColorSpaceType_Undefined: Undefined unitialized default value, triggers error when used.

enumerator ImageColorSpaceType_GRAY: Grayscale (monochrome)

enumerator ImageColorSpaceType_RGB: RGB (red-green-blue)

enumerator ImageColorSpaceType_CMYK: CMYK (cyan-magenta-yellow-black)

class ArrayObjectHandle : public ObjectHandle 

#include <c_array_object.h>

An array object is a one-dimensional collection of objects arranged sequentially.

Unnamed Group

error_type ArrayObject_Create(ArrayObjectHandle **result): Creates a new ArrayObject instance.

error_type ArrayObject_GetSize(ArrayObjectHandle *handle, size_type *result): Return size of an array.

error_type ArrayObject_GetValue(ArrayObjectHandle *handle, size_type at, ObjectHandle **result): Get element at location at.

error_type ArrayObject_SetValue(ArrayObjectHandle *handle, size_type at, ObjectHandle *value): Set element at location at.

error_type ArrayObject_Append(ArrayObjectHandle *handle, ObjectHandle *value): Insert new element at the end of the array.

error_type ArrayObject_Insert(ArrayObjectHandle *handle, size_type at, ObjectHandle *value): Insert new element at location at.

error_type ArrayObject_Remove(ArrayObjectHandle *handle, size_type at): Remove element from location at.

error_type ArrayObject_Clear(ArrayObjectHandle *handle): Clear all items from the collection.

error_type ArrayObject_ToObject(ArrayObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type ArrayObject_FromObject(ObjectHandle *handle, ArrayObjectHandle **result): Convert ObjectHandle to ArrayObjectHandle.

error_type ArrayObject_Release(ArrayObjectHandle *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

class BooleanObjectHandle : public ObjectHandle 

#include <c_boolean_object.h>

Boolean objects represent the logical values of true and false.

Unnamed Group

error_type BooleanObject_Create(BooleanObjectHandle **result): Creates a new instance.

error_type BooleanObject_GetValue(BooleanObjectHandle *handle, boolean_type *result): Return current boolean value.

error_type BooleanObject_SetValue(BooleanObjectHandle *handle, boolean_type value): Set new boolean value.

error_type BooleanObject_ToObject(BooleanObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type BooleanObject_FromObject(ObjectHandle *handle, BooleanObjectHandle **result): Convert ObjectHandle to BooleanObjectHandle.

error_type BooleanObject_Release(BooleanObjectHandle *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

class DictionaryObjectHandle : public ObjectHandle 

#include <c_dictionary_object.h>

A dictionary object is an associative table containing pairs of objects.

Unnamed Group

error_type DictionaryObject_Create(DictionaryObjectHandle **result): Creates a new dictionary instance.

error_type DictionaryObject_GetSize(DictionaryObjectHandle *handle, size_type *result): Return size of collection.

error_type DictionaryObject_Find(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle **result): Find mapped value for key key.

error_type DictionaryObject_TryFind(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result, ObjectHandle **result_object): Find mapped value for key key, however does not return an error in case the entry is missing.

error_type DictionaryObject_Contains(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result): Determine if collection contains key.

error_type DictionaryObject_GetIterator(DictionaryObjectHandle *handle, DictionaryObjectIteratorHandle **result)

Get collection iterator for enumerating all entries.

Modifying collection may invalidate this handle.

error_type DictionaryObject_Remove(DictionaryObjectHandle *handle, const NameObjectHandle *key, boolean_type *result): Remove key-value pair from collection.

error_type DictionaryObject_Clear(DictionaryObjectHandle *handle): Remove all items from the collection.

error_type DictionaryObject_Insert(DictionaryObjectHandle *handle, NameObjectHandle *key, ObjectHandle *value, boolean_type overwrite): Insert new key-value pair into collection.

error_type DictionaryObject_InsertConst(DictionaryObjectHandle *handle, const NameObjectHandle *key, ObjectHandle *value, boolean_type overwrite): Insert new key-value pair into collection.

error_type DictionaryObject_ToObject(DictionaryObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type DictionaryObject_FromObject(ObjectHandle *handle, DictionaryObjectHandle **result): Convert ObjectHandle to DictionaryObjectHandle.

error_type DictionaryObject_Release(DictionaryObjectHandle *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

DictionaryObjectIterator_IsValid

class DictionaryObjectIteratorHandle : public IUnknownHandle 

#include <c_dictionary_object.h>

Used for accessing Dictionary elements through iterator interface.

Unnamed Group

error_type DictionaryObjectIterator_GetKey(DictionaryObjectIteratorHandle *handle, NameObjectHandle **result)

Get key at iterator position.

Ensure the iterator is valid.

See also

error_type DictionaryObjectIterator_GetValue(DictionaryObjectIteratorHandle *handle, ObjectHandle **result)

Get value at iterator position.

Ensure the iterator is valid.

See also

DictionaryObjectIterator_IsValid

error_type DictionaryObjectIterator_IsValid(DictionaryObjectIteratorHandle *handle, boolean_type *result)

Determine if current position is valid.

Invalid position may mean that iterator moved past the end of the collection, as well as the collection was modified.

Any other operation except THIS will fail on invalid iterator.

error_type DictionaryObjectIterator_Next(DictionaryObjectIteratorHandle *handle)

Advances iterator to the next position.

Ensure the iterator is valid.

See also

DictionaryObjectIterator_IsValid

error_type DictionaryObjectIterator_ToUnknown(DictionaryObjectIteratorHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type DictionaryObjectIterator_FromUnknown(IUnknownHandle *handle, DictionaryObjectIteratorHandle **result): Convert IUnknownHandle to DictionaryObjectIteratorHandle.

error_type DictionaryObjectIterator_Release(DictionaryObjectIteratorHandle *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

class IndirectReferenceObjectHandle : public ObjectHandle 

#include <c_indirect_reference_object.h>

Represents reference to another object.

Unnamed Group

error_type IndirectReferenceObject_Create(IndirectReferenceObjectHandle **result): Creates a new IndirectReferenceObject instance.

error_type IndirectReferenceObject_GetReferencedObjectNumber(IndirectReferenceObjectHandle *handle, biguint_type *result): Return object number of referenced object.

error_type IndirectReferenceObject_GetReferencedGenerationNumber(IndirectReferenceObjectHandle *handle, ushort_type *result): Return generation number of referenced object.

error_type IndirectReferenceObject_GetReferencedObject(IndirectReferenceObjectHandle *handle, ObjectHandle **result): Return object handle to referenced object.

error_type IndirectReferenceObject_SetObjectNumber(IndirectReferenceObjectHandle *handle, biguint_type value): Set the object number of the referenced object.

error_type IndirectReferenceObject_SetGenerationNumber(IndirectReferenceObjectHandle *handle, ushort_type value): Set the generation number of the referenced object.

error_type IndirectReferenceObject_SetReferencedObject(IndirectReferenceObjectHandle *handle, ObjectHandle *value): Sets a new referenced object.

error_type IndirectReferenceObject_ToObject(IndirectReferenceObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type IndirectReferenceObject_FromObject(ObjectHandle *handle, IndirectReferenceObjectHandle **result): Convert ObjectHandle to IndirectReferenceObjectHandle.

error_type IndirectReferenceObject_Release(IndirectReferenceObjectHandle *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

class IntegerObjectHandle : public ObjectHandle 

#include <c_integer_object.h>

Integer objects represent mathematical integers.

Unnamed Group

error_type IntegerObject_Create(IntegerObjectHandle **result): Creates a new IntegerObject instance.

error_type IntegerObject_CreateFromIntegerValue(bigint_type value, IntegerObjectHandle **result): Creates a new IntegerObject instance with signed integer value.

error_type IntegerObject_CreateFromUnsignedIntegerValue(biguint_type value, IntegerObjectHandle **result): Creates a new IntegerObject instance with unsigned integer value.

error_type IntegerObject_GetIntegerValue(IntegerObjectHandle *handle, bigint_type *result): Return objects contained integer value.

error_type IntegerObject_GetUnsignedIntegerValue(IntegerObjectHandle *handle, biguint_type *result): Return objects contained unsigned integer value.

error_type IntegerObject_SetIntegerValue(IntegerObjectHandle *handle, bigint_type value): Set objects new integer value.

error_type IntegerObject_SetUnsignedIntegerValue(IntegerObjectHandle *handle, biguint_type value): Set objects new unsigned integer value.

error_type IntegerObject_ToObject(IntegerObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type IntegerObject_FromObject(ObjectHandle *handle, IntegerObjectHandle **result): Convert ObjectHandle to IntegerObjectHandle.

error_type IntegerObject_Release(IntegerObjectHandle *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

class NameObjectHandle : public ObjectHandle 

#include <c_name_object.h>

A name object is an atomic symbol uniquely defined by a sequence of characters.

See also

Name constants

Unnamed Group

error_type NameObject_Create(NameObjectHandle **result): Creates a new NameObject instance.

error_type NameObject_CreateFromEncodedString(string_type value, NameObjectHandle **result): Creates a new NameObject instance from PDF encoded data.

error_type NameObject_CreateFromDecodedString(string_type value, NameObjectHandle **result): Creates a new NameObject instance from decoded data without PDF syntax.

error_type NameObject_GetValue(const NameObjectHandle *handle, BufferHandle **result): Get names binary representation.

error_type NameObject_SetValue(NameObjectHandle *handle, BufferHandle *value): Set names new value.

error_type NameObject_Equals(const NameObjectHandle *handle, const NameObjectHandle *other, boolean_type *result): Compares two name objects.

error_type NameObject_Hash(const NameObjectHandle *handle, size_type *result): Get object hash code.

error_type NameObject_ToObject(NameObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type NameObject_FromObject(ObjectHandle *handle, NameObjectHandle **result): Convert ObjectHandle to NameObjectHandle.

error_type NameObject_Release(NameObjectHandle *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

class NullObjectHandle : public ObjectHandle 

#include <c_null_object.h>

The null object has a type and value that are unequal to those of any other object.

Unnamed Group

error_type NullObject_Create(NullObjectHandle **result): Creates a new NullObject instance.

error_type NullObject_ToObject(NullObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type NullObject_FromObject(ObjectHandle *handle, NullObjectHandle **result): Convert ObjectHandle to NullObjectHandle.

error_type NullObject_Release(NullObjectHandle *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

class ObjectHandle : public IUnknownHandle 

#include <c_object.h>

Base class for syntactic tokens.

Subclassed by ArrayObjectHandle, BooleanObjectHandle, DictionaryObjectHandle, IndirectReferenceObjectHandle, IntegerObjectHandle, NameObjectHandle, NullObjectHandle, RealObjectHandle, StreamObjectHandle, StringObjectHandle

Unnamed Group

error_type Object_GetObjectType(ObjectHandle *handle, ObjectType *result): Get derived type of current object.

error_type Object_TypeName(ObjectType type, string_type *result): Get string representation of object type.

error_type Object_GetOffset(ObjectHandle *handle, offset_type *result): Get input file offset where this object was found.

error_type Object_GetAttributeList(ObjectHandle *handle, ObjectAttributeListHandle **result): Get object attribute list attached to this PDF object.

error_type Object_Hash(const ObjectHandle *handle, size_type *result): Compute hash value for this object.

error_type Object_ToString(ObjectHandle *handle, BufferHandle **result): Convert to human readable text format.

error_type Object_ToPdf(ObjectHandle *handle, BufferHandle **result): Get a PDF data representation of the current object.

error_type Object_ToUnknown(ObjectHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type Object_FromUnknown(IUnknownHandle *handle, ObjectHandle **result): Convert IUnknownHandle to ObjectHandle.

error_type Object_Release(ObjectHandle *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

BaseObjectAttributeHandle

class ObjectAttributeListHandle : public IUnknownHandle 

#include <c_object_attribute_list.h>

Represents a list of object attributes.

See also

Unnamed Group

error_type ObjectAttributeList_Create(ObjectAttributeListHandle **result): Create new ObjectAttributeList instance.

error_type ObjectAttributeList_Add(ObjectAttributeListHandle *handle, BaseObjectAttributeHandle *value, boolean_type overwrite): Adds an element with the provided key and value to the list.

error_type ObjectAttributeList_Remove(ObjectAttributeListHandle *handle, ObjectAttributeType key, boolean_type *result): Removes the element with the specified key from the list.

error_type ObjectAttributeList_Contains(ObjectAttributeListHandle *handle, ObjectAttributeType key, boolean_type *result): Determine if collection contains key.

error_type ObjectAttributeList_Get(ObjectAttributeListHandle *handle, ObjectAttributeType key, BaseObjectAttributeHandle **result): Find mapped value for key key.

error_type ObjectAttributeList_Clear(ObjectAttributeListHandle *handle): Remove all items from the collection.

error_type ObjectAttributeList_ToUnknown(ObjectAttributeListHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type ObjectAttributeList_FromUnknown(IUnknownHandle *handle, ObjectAttributeListHandle **result): Convert IUnknownHandle to ObjectAttributeListHandle.

error_type ObjectAttributeList_Release(ObjectAttributeListHandle *handle)

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

class BaseObjectAttributeHandle : public IUnknownHandle 

#include <c_object_attributes.h>

Base class for representing object attributes that are augumenting specific properties with additional metadata.

Subclassed by ImageMetadataObjectAttributeHandle, SerializationOverrideObjectAttributeHandle

Unnamed Group

error_type BaseObjectAttribute_GetAttributeType(BaseObjectAttributeHandle *handle, ObjectAttributeType *result): Get derived type of current object attribute.

error_type BaseObjectAttribute_ToUnknown(BaseObjectAttributeHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type BaseObjectAttribute_FromUnknown(IUnknownHandle *handle, BaseObjectAttributeHandle **result): Convert IUnknownHandle to BaseObjectAttributeHandle.

error_type BaseObjectAttribute_Release(BaseObjectAttributeHandle *handle)

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

class ImageMetadataObjectAttributeHandle : public BaseObjectAttributeHandle 

#include <c_object_attributes.h>

Attribute object that contains information about image colorspace and components.

Unnamed Group

error_type ImageMetadataObjectAttribute_Create(ImageMetadataObjectAttributeHandle **result): Creates a new ImageMetadataObjectAttribute instance.

error_type ImageMetadataObjectAttribute_GetColorComponents(ImageMetadataObjectAttributeHandle *handle, integer_type *result): Get number of color components inside the associated image.

error_type ImageMetadataObjectAttribute_SetColorComponents(ImageMetadataObjectAttributeHandle *handle, integer_type data): Set number of color components inside the associated image.

error_type ImageMetadataObjectAttribute_GetColorSpace(ImageMetadataObjectAttributeHandle *handle, ImageColorSpaceType *result): Get color space of the associated image.

error_type ImageMetadataObjectAttribute_SetColorSpace(ImageMetadataObjectAttributeHandle *handle, ImageColorSpaceType data): Set color space of the associated image.

error_type ImageMetadataObjectAttribute_GetWidth(ImageMetadataObjectAttributeHandle *handle, integer_type *result): Get image width in pixels.

error_type ImageMetadataObjectAttribute_SetWidth(ImageMetadataObjectAttributeHandle *handle, integer_type data): Set image width in pixels.

error_type ImageMetadataObjectAttribute_GetHeight(ImageMetadataObjectAttributeHandle *handle, integer_type *result): Get image height in pixels.

error_type ImageMetadataObjectAttribute_SetHeight(ImageMetadataObjectAttributeHandle *handle, integer_type data): Set image height in pixels.

error_type ImageMetadataObjectAttribute_ToBaseAttribute(ImageMetadataObjectAttributeHandle *handle, BaseObjectAttributeHandle **result): Reinterpret current object as BaseObjectAttributeHandle.

error_type ImageMetadataObjectAttribute_FromBaseAttribute(BaseObjectAttributeHandle *handle, ImageMetadataObjectAttributeHandle **result): Convert BaseObjectAttributeHandle to ImageMetadataObjectAttributeHandle.

error_type ImageMetadataObjectAttribute_Release(ImageMetadataObjectAttributeHandle *handle)

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

class SerializationOverrideObjectAttributeHandle : public BaseObjectAttributeHandle 

#include <c_object_attributes.h>

Attribute that modifies the attached object serialization ToPdf.

See also

ObjectHandle::Object_ToPdf

Unnamed Group

error_type SerializationOverrideObjectAttribute_Create(SerializationOverrideObjectAttributeHandle **result): Creates a new SerializationOverrideObjectAttribute instance.

error_type SerializationOverrideObjectAttribute_CreateFromData(string_type data, size_type size, SerializationOverrideObjectAttributeHandle **result): Creates a new SerializationOverrideObjectAttribute instance with value specified in data and size.

error_type SerializationOverrideObjectAttribute_ToBaseAttribute(SerializationOverrideObjectAttributeHandle *handle, BaseObjectAttributeHandle **result): Reinterpret current object as BaseObjectAttributeHandle.

error_type SerializationOverrideObjectAttribute_FromBaseAttribute(BaseObjectAttributeHandle *handle, SerializationOverrideObjectAttributeHandle **result): Convert BaseObjectAttributeHandle to SerializationOverrideObjectAttributeHandle.

error_type SerializationOverrideObjectAttribute_Release(SerializationOverrideObjectAttributeHandle *handle)

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

class RealObjectHandle : public ObjectHandle 

#include <c_real_object.h>

Real objects represent mathematical real numbers.

Unnamed Group

error_type RealObject_Create(RealObjectHandle **result): Creates a new RealObject instance.

error_type RealObject_CreateFromData(real_type data, integer_type precision, RealObjectHandle **result): Creates a new RealObject instance with specified data.

error_type RealObject_GetValue(RealObjectHandle *handle, real_type *result): Return objects contained real value.

error_type RealObject_SetValue(RealObjectHandle *handle, real_type value): Set objects new real value.

error_type RealObject_ToObject(RealObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type RealObject_FromObject(ObjectHandle *handle, RealObjectHandle **result): Convert ObjectHandle to RealObjectHandle.

error_type RealObject_Release(RealObjectHandle *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

class StreamObjectHandle : public ObjectHandle 

#include <c_stream_object.h>

Stream object represents compressed data inside document.

Unnamed Group

error_type StreamObject_Create(StreamObjectHandle **result): Creates a new StreamObject instance.

error_type StreamObject_GetHeader(StreamObjectHandle *handle, DictionaryObjectHandle **result): Return streams header dictionary.

error_type StreamObject_SetHeader(StreamObjectHandle *handle, DictionaryObjectHandle *value): Set new streams header dictionary.

error_type StreamObject_GetBodyRaw(StreamObjectHandle *handle, BufferHandle **result)

Get uncompressed stream body.

This function is useful when the library cannot decompress or decrypt the stream data.

error_type StreamObject_GetBody(StreamObjectHandle *handle, BufferHandle **result): Get decompressed stream content.

error_type StreamObject_SetBody(StreamObjectHandle *handle, BufferHandle *value)

Set new stream content.

This sets the decompressed content. Compression is done when the file is saved.

error_type StreamObject_ToObject(StreamObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type StreamObject_FromObject(ObjectHandle *handle, StreamObjectHandle **result): Convert ObjectHandle to StreamObjectHandle.

error_type StreamObject_Release(StreamObjectHandle *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

class StringObjectHandle : public ObjectHandle 

#include <c_string_object.h>

Reprsents human readable text.

Subclassed by HexadecimalStringObjectHandle, LiteralStringObjectHandle

Unnamed Group

error_type StringObject_GetStringType(StringObjectHandle *handle, StringType *result): Get derived type from current string.

error_type StringObject_GetValue(StringObjectHandle *handle, BufferHandle **result): Get strings current value.

error_type StringObject_SetValue(StringObjectHandle *handle, BufferHandle *value): Set strings new value.

error_type StringObject_ToObject(StringObjectHandle *handle, ObjectHandle **result): Reinterpret current object as ObjectHandle.

error_type StringObject_FromObject(ObjectHandle *handle, StringObjectHandle **result): Convert ObjectHandle to StringObjectHandle.

error_type StringObject_Release(StringObjectHandle *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

class HexadecimalStringObjectHandle : public StringObjectHandle 

#include <c_string_object.h>

A hexadecimal string is preferable for arbitrary binary data.

Unnamed Group

error_type HexadecimalStringObject_Create(HexadecimalStringObjectHandle **result): Creates a new HexadecimalStringObject instance.

error_type HexadecimalStringObject_CreateFromEncodedBuffer(BufferHandle *value, HexadecimalStringObjectHandle **result): Creates a new HexadecimalStringObject instance from encoded data.

error_type HexadecimalStringObject_CreateFromEncodedString(string_type value, HexadecimalStringObjectHandle **result): Creates a new HexadecimalStringObject instance from encoded string data.

error_type HexadecimalStringObject_CreateFromDecodedBuffer(BufferHandle *value, HexadecimalStringObjectHandle **result): Creates a new HexadecimalStringObject instance from decoded data.

error_type HexadecimalStringObject_CreateFromDecodedString(string_type value, HexadecimalStringObjectHandle **result): Creates a new HexadecimalStringObject instance from decoded string data.

error_type HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle *handle, BufferHandle **result): Get strings current value.

error_type HexadecimalStringObject_SetValue(HexadecimalStringObjectHandle *handle, BufferHandle *value): Set strings new value.

error_type HexadecimalStringObject_ToStringObject(HexadecimalStringObjectHandle *handle, StringObjectHandle **result): Reinterpret current object as StringObjectHandle.

error_type HexadecimalStringObject_FromStringObject(StringObjectHandle *handle, HexadecimalStringObjectHandle **result): Convert IUnknownHandle to HexadecimalStringObjectHandle.

error_type HexadecimalStringObject_Release(HexadecimalStringObjectHandle *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

class LiteralStringObjectHandle : public StringObjectHandle 

#include <c_string_object.h>

A literal string is preferable for printable data.

Unnamed Group

error_type LiteralStringObject_Create(LiteralStringObjectHandle **result): Creates a new LiteralStringObjectHandle instance.

error_type LiteralStringObject_CreateFromEncodedBuffer(BufferHandle *value, LiteralStringObjectHandle **result): Creates a new LiteralStringObjectHandle instance from PDF encoded data.

error_type LiteralStringObject_CreateFromEncodedString(string_type value, LiteralStringObjectHandle **result): Creates a new LiteralStringObjectHandle instance from PDF encoded string data.

error_type LiteralStringObject_CreateFromDecodedBuffer(BufferHandle *value, LiteralStringObjectHandle **result): Creates a new LiteralStringObjectHandle instance from decoded data without PDF syntax.

error_type LiteralStringObject_CreateFromDecodedString(string_type value, LiteralStringObjectHandle **result): Creates a new LiteralStringObjectHandle instance from decoded string data without PDF syntax.

error_type LiteralStringObject_GetValue(LiteralStringObjectHandle *handle, BufferHandle **result): Get strings current value.

error_type LiteralStringObject_SetValue(LiteralStringObjectHandle *handle, BufferHandle *value): Set strings new value.

error_type LiteralStringObject_ToStringObject(LiteralStringObjectHandle *handle, StringObjectHandle **result): Reinterpret current object as StringObjectHandle.

error_type LiteralStringObject_FromStringObject(StringObjectHandle *handle, LiteralStringObjectHandle **result): Convert IUnknownHandle to LiteralStringObjectHandle.

error_type LiteralStringObject_Release(LiteralStringObjectHandle *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

Cross-Reference Tables and Streams

class XrefHandle : public IUnknownHandle 

#include <c_xref.h>

The cross-reference table contains information that permits random access to indirect objects within the file.

Unnamed Group

error_type Xref_Create(XrefHandle **result): Creates a new instance.

error_type Xref_Insert(XrefHandle *handle, XrefEntryHandle *entry): Insert new entry into the collection.

error_type Xref_Contains(XrefHandle *handle, biguint_type object_number, boolean_type *result): Determine if collection contains object_number.

error_type Xref_Find(XrefHandle *handle, biguint_type object_number, XrefEntryHandle **result): Find mapped value for key object_number.

error_type Xref_Remove(XrefHandle *handle, biguint_type object_number, boolean_type *result): Remove entry with key object_number from the collection.

error_type Xref_Clear(XrefHandle *handle): Remove all items from the collection.

error_type Xref_GetTrailerDictionary(XrefHandle *handle, DictionaryObjectHandle **result)

Get cross-reference table meta-data dictionary.

For cross-reference tables it is the trailer dictionary after all entries. For cross-reference streams it is the streams dictionary.

error_type Xref_GetLastXrefOffset(XrefHandle *handle, offset_type *result): Get byte offset in the decoded stream from the beginning of the file to the beginning of the xref keyword in the last cross-reference section.

error_type Xref_GetIterator(XrefHandle *handle, XrefIteratorHandle **result): Get cross-reference entry iterator.

error_type Xref_ToUnknown(XrefHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type Xref_FromUnknown(IUnknownHandle *handle, XrefHandle **result): Convert IUnknownHandle to XrefHandle.

error_type Xref_Release(XrefHandle *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

class XrefIteratorHandle : public IUnknownHandle 

#include <c_xref.h>

A pointer to XrefEntryHandle within XrefHandle collection.

This object is useful for iterating over whole entry collecion.

See also

XrefIterator_Next

See also

XrefIterator_GetValue

Unnamed Group

error_type XrefIterator_GetValue(XrefIteratorHandle *handle, XrefEntryHandle **result): Get cross-reference entry from current iterator position.

error_type XrefIterator_Next(XrefIteratorHandle *handle): Advance iterator to the next position.

error_type XrefIterator_IsValid(XrefIteratorHandle *handle, boolean_type *result): Check if the current iterator position is valid.

error_type XrefIterator_ToUnknown(XrefIteratorHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type XrefIterator_FromUnknown(IUnknownHandle *handle, XrefIteratorHandle **result): Convert IUnknownHandle to XrefIteratorHandle.

error_type XrefIterator_Release(XrefIteratorHandle *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

class XrefEntryHandle : public IUnknownHandle 

#include <c_xref.h>

Cross-reference entry represents item within XrefHandle.

Subclassed by XrefCompressedEntryHandle, XrefFreeEntryHandle, XrefUsedEntryHandle

Unnamed Group

error_type XrefEntry_GetType(XrefEntryHandle *handle, XrefEntryType *result): Get entry type.

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.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

class XrefFreeEntryHandle : public XrefEntryHandle 

#include <c_xref.h>

Represents free entry within cross-reference section.

Free entry means, that this object is not used in the document. It can be reused in the new cross-reference section.

Unnamed Group

error_type XrefFreeEntry_Create(biguint_type object_number, ushort_type generation_number, biguint_type next_free_object, XrefFreeEntryHandle **result): Creates a new instance.

error_type XrefFreeEntry_GetObjectNumber(XrefFreeEntryHandle *handle, biguint_type *result): Get entry object number.

error_type XrefFreeEntry_GetGenerationNumber(XrefFreeEntryHandle *handle, ushort_type *result): Get entry generation number.

error_type XrefFreeEntry_InUse(XrefFreeEntryHandle *handle, boolean_type *result): Quick check, if the entry is used or compressed.

error_type XrefFreeEntry_GetNextFreeObjectNumber(XrefFreeEntryHandle *handle, biguint_type *result): Object number of the next free object.

error_type XrefFreeEntry_ToEntry(XrefFreeEntryHandle *handle, XrefEntryHandle **result): Reinterpret current object as XrefEntryHandle.

error_type XrefFreeEntry_FromEntry(XrefEntryHandle *handle, XrefFreeEntryHandle **result): Convert XrefEntryHandle to XrefFreeEntryHandle.

error_type XrefFreeEntry_Release(XrefFreeEntryHandle *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

class XrefUsedEntryHandle : public XrefEntryHandle 

#include <c_xref.h>

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.

Unnamed Group

error_type XrefUsedEntry_Create(biguint_type object_number, ushort_type generation_number, offset_type offset, XrefUsedEntryHandle **result): Creates a new instance.

error_type XrefUsedEntry_GetObjectNumber(XrefUsedEntryHandle *handle, biguint_type *result): Get entry object number.

error_type XrefUsedEntry_GetGenerationNumber(XrefUsedEntryHandle *handle, ushort_type *result): Get entry generation number.

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.

error_type XrefUsedEntry_GetReference(XrefUsedEntryHandle *handle, ObjectHandle **result): Get reference to the object represented by this entry.

error_type XrefUsedEntry_SetReference(XrefUsedEntryHandle *handle, ObjectHandle *data): Set 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.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

class XrefCompressedEntryHandle : public XrefEntryHandle 

#include <c_xref.h>

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.

Unnamed Group

error_type 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 XrefCompressedEntry_GetObjectNumber(XrefCompressedEntryHandle *handle, biguint_type *result): Get entry object number.

error_type XrefCompressedEntry_GetGenerationNumber(XrefCompressedEntryHandle *handle, ushort_type *result): Get entry generation number.

error_type XrefCompressedEntry_InUse(XrefCompressedEntryHandle *handle, boolean_type *result): Quick check, if the entry is used or compressed.

error_type XrefCompressedEntry_GetReference(XrefCompressedEntryHandle *handle, ObjectHandle **result): Get reference to the object represented by this entry.

error_type XrefCompressedEntry_SetReference(XrefCompressedEntryHandle *handle, ObjectHandle *data): Set 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.

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

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.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

class XrefChainHandle : public IUnknownHandle 

#include <c_xref.h>

An ordered collection of all XrefHandle within the PDF file.

Unnamed Group

error_type XrefChain_GetIterator(XrefChainHandle *handle, XrefChainIteratorHandle **result): Get cross-reference section iterator.

error_type XrefChain_ToUnknown(XrefChainHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type XrefChain_FromUnknown(IUnknownHandle *handle, XrefChainHandle **result): Convert IUnknownHandle to XrefChainHandle.

error_type XrefChain_Release(XrefChainHandle *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

XrefChainIterator_GetValue

class XrefChainIteratorHandle : public IUnknownHandle 

#include <c_xref.h>

A pointer to XrefHandle within XrefChainHandle collection.

This method is useful for iterating over whole entry collecion.

See also

XrefChainIterator_Next

See also

Unnamed Group

error_type XrefChainIterator_GetValue(XrefChainIteratorHandle *handle, XrefHandle **result): Get cross-reference section from current iterator position.

error_type XrefChainIterator_Next(XrefChainIteratorHandle *handle): Advance iterator to the next position.

error_type XrefChainIterator_IsValid(XrefChainIteratorHandle *handle, boolean_type *result): Determine if the current iterator position is valid.

error_type XrefChainIterator_ToUnknown(XrefChainIteratorHandle *handle, IUnknownHandle **result): Reinterpret current object as IUnknownHandle.

error_type XrefChainIterator_FromUnknown(IUnknownHandle *handle, XrefChainIteratorHandle **result): Convert IUnknownHandle to XrefChainIteratorHandle.

error_type XrefChainIterator_Release(XrefChainIteratorHandle *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