Documents

class ByteRangeCollectionHandle : public IUnknownHandle

#include <c_byte_range.h>

Represents a collection of ByteRangeHandle.

ByteRangeCollection is used to specify exact byte ranges for digest calculation in digital signatures. Multiple discontiguous byte ranges are used to describe a digest that does not include the signature value itself.

Unnamed Group

error_type ByteRangeCollection_Create(ByteRangeCollectionHandle **result)

Create an empty ByteRangeCollection.

Parameters:

result – Output ByteRangeCollection handle

error_type ByteRangeCollection_Append(ByteRangeCollectionHandle *handle, ByteRangeHandle *byte_range)

Append a ByteRange to the end of the collection.

Parameters:

• handle – ByteRangeCollection handle

• byte_range – ByteRange to append

error_type ByteRangeCollection_Insert(ByteRangeCollectionHandle *handle, size_type at, ByteRangeHandle *byte_range)

Insert a ByteRange at a specific position in the collection.

Parameters:

• handle – ByteRangeCollection handle

• at – Position to insert at

• byte_range – ByteRange to insert

error_type ByteRangeCollection_Remove(ByteRangeCollectionHandle *handle, size_type at)

Remove a ByteRange at a specific position.

Parameters:

• handle – ByteRangeCollection handle

• at – Position to remove from

error_type ByteRangeCollection_Clear(ByteRangeCollectionHandle *handle)

Remove all ByteRanges from the collection.

Parameters:

handle – ByteRangeCollection handle

error_type ByteRangeCollection_GetSize(ByteRangeCollectionHandle *handle, size_type *result)

Get size of byte range collection.

error_type ByteRangeCollection_GetValue(ByteRangeCollectionHandle *handle, size_type at, ByteRangeHandle **result)

Get single byte range from array at specific position.

error_type ByteRangeCollection_Release(ByteRangeCollectionHandle *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

IUnknown_Release

class ByteRangeHandle : public IUnknownHandle

#include <c_byte_range.h>

Represents starting byte offset and length.

ByteRange represents a single contiguous byte range in a PDF file, defined by a starting offset and a length.

Unnamed Group

error_type ByteRange_Create(ByteRangeHandle **result)

Create an empty ByteRange.

Parameters:

result – Output ByteRange handle

error_type ByteRange_CreateFromData(IntegerObjectHandle *offset, IntegerObjectHandle *length, ByteRangeHandle **result)

Create a ByteRange with offset and length values.

Parameters:

• offset – Starting byte offset

• length – Length in bytes

• result – Output ByteRange handle

error_type ByteRange_GetOffset(ByteRangeHandle *handle, IntegerObjectHandle **result)

Get starting offset of byte range.

error_type ByteRange_GetLength(ByteRangeHandle *handle, IntegerObjectHandle **result)

Get length of byte range.

error_type ByteRange_SetOffset(ByteRangeHandle *handle, IntegerObjectHandle *offset)

Set starting offset of byte range.

Parameters:

• handle – ByteRange handle

• offset – New starting byte offset

error_type ByteRange_SetLength(ByteRangeHandle *handle, IntegerObjectHandle *length)

Set length of byte range.

Parameters:

• handle – ByteRange handle

• length – New length in bytes

error_type ByteRange_Release(ByteRangeHandle *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

IUnknown_Release

class CatalogHandle : public IUnknownHandle

#include <c_catalog.h>

The root of a document’s object hierarchy.

See also

DocumentHandle

Unnamed Group

error_type Catalog_GetPages(CatalogHandle *handle, PageTreeHandle **result)

The root of the document’s page tree (see 7.7.3, “Page Tree”).

error_type Catalog_GetPageLabels(CatalogHandle *handle, PageLabelsHandle **result)

A number tree defining the page labelling for the document (see 12.4.2, “Page Labels”).

error_type Catalog_GetPageLayout(CatalogHandle *handle, PageLayout *result)

Page layout which shall be used when the document is opened.

error_type Catalog_GetVersion(CatalogHandle *handle, PDFVersion *result)

The version of the PDF specification to which the document conforms if later than the version specified in the file’s header.

If the header specifies a later version, or if this entry is absent, the document shall conform to the version specified in the header.

error_type Catalog_GetExtensions(CatalogHandle *handle, DeveloperExtensionsHandle **result)

An extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document.

7.12, “Extensions Dictionary”, describes this dictionary and how it shall be used.

error_type Catalog_GetViewerPreferences(CatalogHandle *handle, ViewerPreferencesHandle **result)

The way the document shall be displayed on the screen.

If this entry is absent, conforming readers shall use their own current user preference settings.

error_type Catalog_GetOutlines(CatalogHandle *handle, OutlineHandle **result)

Root of the document’s outline hierarchy (see 12.3.3, “Document Outline”).

error_type Catalog_GetDestinations(CatalogHandle *handle, NamedDestinationsHandle **result)

A dictionary of names and corresponding destinations (see 12.3.2.3, “Named Destinations”).

error_type Catalog_GetAcroForm(CatalogHandle *handle, InteractiveFormHandle **result)

The document’s interactive form (see 12.7, “Interactive Forms”).

error_type Catalog_ToUnknown(CatalogHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Catalog_FromUnknown(IUnknownHandle *handle, CatalogHandle **result)

Convert IUnknownHandle to CatalogHandle.

error_type Catalog_Release(CatalogHandle *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

IUnknown_Release

class CharacterMapHandle : public IUnknownHandle

#include <c_character_map.h>

A CMap shall specify the mapping from character codes to character selectors.

Subclassed by EmbeddedCharacterMapHandle, UnicodeCharacterMapHandle

Unnamed Group

error_type CharacterMap_GetCharacterMapType(CharacterMapHandle *handle, CharacterMapType *result)

Get derived type of current object.

error_type CharacterMap_ToUnknown(CharacterMapHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type CharacterMap_FromUnknown(IUnknownHandle *handle, CharacterMapHandle **result)

Convert IUnknownHandle to FontHandle.

error_type CharacterMap_Release(CharacterMapHandle *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

IUnknown_Release

class EmbeddedCharacterMapHandle : public CharacterMapHandle

#include <c_character_map.h>

For character encodings that are not predefined, the PDF file shall contain a stream that defines the CMap.

Unnamed Group

error_type EmbeddedCharacterMap_ToCharacterMap(EmbeddedCharacterMapHandle *handle, CharacterMapHandle **result)

Reinterpret current object as CharacterMapHandle.

error_type EmbeddedCharacterMap_FromCharacterMap(CharacterMapHandle *handle, EmbeddedCharacterMapHandle **result)

Convert CharacterMapHandle to EmbeddedCharacterMapHandle.

error_type EmbeddedCharacterMap_Release(EmbeddedCharacterMapHandle *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

IUnknown_Release

class UnicodeCharacterMapHandle : public CharacterMapHandle

#include <c_character_map.h>

The Unicode standard defines a system for numbering all of the common characters used in a large number of languages.

Unnamed Group

error_type UnicodeCharacterMap_GetMappedValue(UnicodeCharacterMapHandle *handle, BufferHandle *key_handle, BufferHandle **result)

Get unicode representation of key key_handle.

error_type UnicodeCharacterMap_ToCharacterMap(UnicodeCharacterMapHandle *handle, CharacterMapHandle **result)

Reinterpret current object as CharacterMapHandle.

error_type UnicodeCharacterMap_FromCharacterMap(CharacterMapHandle *handle, UnicodeCharacterMapHandle **result)

Convert CharacterMapHandle to UnicodeCharacterMapHandle.

error_type UnicodeCharacterMap_Release(UnicodeCharacterMapHandle *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

IUnknown_Release

class DeveloperExtensionsHandle : public IUnknownHandle

#include <c_developer_extensions.h>

The extensions dictionary, an entry in the document’s catalog dictionary, if present, shall contain one or more entries identifying developer-defined extensions to the ISO 32000-1 Standard.

See also

CatalogHandle

Unnamed Group

error_type DeveloperExtensions_GetIterator(DeveloperExtensionsHandle *handle, DeveloperExtensionsIteratorHandle **result)

Get collection iterator for enumerating all entries.

Modifying collection may invalidate this handle.

error_type DeveloperExtensions_Release(DeveloperExtensionsHandle *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

IUnknown_Release

class DeveloperExtensionsIteratorHandle : public IUnknownHandle

#include <c_developer_extensions.h>

Iterator concept allowing to traverse over DeveloperExtensionsHandle collection.

Unnamed Group

error_type DeveloperExtensionsIterator_GetKey(DeveloperExtensionsIteratorHandle *handle, NameObjectHandle **result)

Get key at iterator position.

Ensure the iterator is valid.

See also

DeveloperExtensionsIterator_IsValid

error_type DeveloperExtensionsIterator_GetValue(DeveloperExtensionsIteratorHandle *handle, DeveloperExtensionHandle **result)

Get value at iterator position.

Ensure the iterator is valid.

See also

DeveloperExtensionsIterator_IsValid

error_type DeveloperExtensionsIterator_IsValid(DeveloperExtensionsIteratorHandle *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 DeveloperExtensionsIterator_Next(DeveloperExtensionsIteratorHandle *handle)

Advances iterator to the next position.

Ensure the iterator is valid.

See also

DeveloperExtensionsIterator_IsValid

error_type DeveloperExtensionsIterator_Release(DeveloperExtensionsIteratorHandle *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

IUnknown_Release

class DeveloperExtensionHandle : public IUnknownHandle

#include <c_developer_extensions.h>

Single item within DeveloperExtensionsHandle collection.

Unnamed Group

error_type DeveloperExtension_GetBaseVersion(DeveloperExtensionHandle *handle, PDFVersion *result)

The name of the PDF version to which this extension applies.

error_type DeveloperExtension_GetExtensionLevel(DeveloperExtensionHandle *handle, IntegerObjectHandle **result)

An integer defined by the developer to denote the extension being used.

If the developer introduces more than one extension to a given BaseVersion the extension level numbers assigned by that developer shall increase over time.

error_type DeveloperExtension_Release(DeveloperExtensionHandle *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

IUnknown_Release

class DigitalSignatureHandle : public IUnknownHandle

#include <c_digital_signature.h>

Represents document’s authenticated digital signature.

For more details please visit section 12.8 - Digital Signatures.

Unnamed Group

error_type DigitalSignature_GetContactInfo(DigitalSignatureHandle *handle, StringObjectHandle **result)

Information provided by the signer to enable a recipient to contact the signer to verify the signature.

error_type DigitalSignature_GetReason(DigitalSignatureHandle *handle, StringObjectHandle **result)

The reason for the signing, such as (I agree…).

error_type DigitalSignature_GetLocation(DigitalSignatureHandle *handle, StringObjectHandle **result)

The CPU host name or physical location of the signing.

error_type DigitalSignature_GetSigningTime(DigitalSignatureHandle *handle, DateHandle **result)

The time of signing.

Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server.

This value should be used only when the time of signing is not available in the signature.

error_type DigitalSignature_GetName(DigitalSignatureHandle *handle, StringObjectHandle **result)

The name of the person or authority signing the document.

This value should be used only when it is not possible to extract the name from the signature.

error_type DigitalSignature_GetRevision(DigitalSignatureHandle *handle, IntegerObjectHandle **result)

The version of the signature handler that was used to create the signature.

error_type DigitalSignature_GetCertificate(DigitalSignatureHandle *handle, StringObjectHandle **result)

An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.

The signing certificate shall appear first in the array. It shall be used to verify the signature value in Contents, and the other certificates shall be used to verify the authenticity of the signing certificate.

error_type DigitalSignature_GetContents(DigitalSignatureHandle *handle, HexadecimalStringObjectHandle **result)

The signature value.

When ByteRange is present, the value shall be a HexadecimalStringObjectHandle representing the value of the byte range digest.

For public-key signatures, Contents should be either a DER-encoded PKCS#1 binary data object or a DER-encoded PKCS#7 binary data object.

error_type DigitalSignature_GetByteRange(DigitalSignatureHandle *handle, ByteRangeCollectionHandle **result)

Exact byte range for the digest calculation.

Multiple discontiguous byte ranges shall be used to describe a digest that does not include the signature value (DigitalSignature_GetContents) itself.

error_type DigitalSignature_Release(DigitalSignatureHandle *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

IUnknown_Release

class DocumentHandle : public IUnknownHandle

#include <c_document.h>

Represents high-level file access handle.

Unnamed Group

error_type Document_Open(string_type filename, DocumentHandle **result)

Opens a new document.

error_type Document_OpenFile(FileHandle *holder, DocumentHandle **result)

Opens a document using already existing file handle.

error_type Document_Create(string_type filename, DocumentHandle **result)

Creates a new document.

error_type Document_CreateFile(FileHandle *holder, DocumentHandle **result)

Creates a new document.

error_type Document_Save(DocumentHandle *handle, string_type filename)

Save file state into new destination.

Destination file will be overwritten if it exists.

error_type Document_SaveFile(DocumentHandle *handle, FileHandle *file_handle)

Save file state into new destination.

Destination file will be overwritten if it exists.

error_type Document_SaveIncremental(DocumentHandle *handle, string_type filename)

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 Document_SaveIncrementalFile(DocumentHandle *handle, FileHandle *file_handle)

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 Document_GetCatalog(DocumentHandle *handle, CatalogHandle **result)

Get document’s catalog property.

error_type Document_GetDocumentInfo(DocumentHandle *handle, DocumentInfoHandle **result)

Get detailed document metadata.

error_type Document_AppendDocument(DocumentHandle *handle, DocumentHandle *source)

Append another document’s contents at the end of the file.

This appends all source document’s pages beyond handle document’s pages.

After pages are merged, all indirect referenced are resolved so they point to correct objects.

The last step fixes link annotations, which can be referenced by page number.

error_type Document_Sign(DocumentHandle *handle, FileHandle *destination, DocumentSignatureSettingsHandle *settings)

Digitally signs the document using specified settings.

error_type Document_AddEncryption(DocumentHandle *handle, DocumentEncryptionSettingsHandle *settings)

Encrypt the document using the specified settings.

error_type Document_RemoveEncryption(DocumentHandle *handle)

Remove any existing encryption from the document.

The document MUST be unlocked either with password or encryption key.

See also

FileHandle::File_SetEncryptionPassword

See also

FileHandle::File_SetEncryptionKey

error_type Document_ToUnknown(DocumentHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Document_FromUnknown(IUnknownHandle *handle, DocumentHandle **result)

Convert IUnknownHandle to DocumentHandle.

error_type Document_Release(DocumentHandle *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

IUnknown_Release

class DocumentEncryptionSettingsHandle : public IUnknownHandle

#include <c_document_encryption_settings.h>

Group of settings controlling document’s encryption and decryption.

Unnamed Group

error_type DocumentEncryptionSettings_Create(DocumentEncryptionSettingsHandle **result)

Creates a new DocumentEncryptionSettings instance.

error_type DocumentEncryptionSettings_GetAlgorithm(DocumentEncryptionSettingsHandle *handle, EncryptionAlgorithmType *result)

Algorithm to be used for document encryption.

error_type DocumentEncryptionSettings_SetAlgorithm(DocumentEncryptionSettingsHandle *handle, EncryptionAlgorithmType encryption_algorithm)

Algorithm to be used for document encryption.

error_type DocumentEncryptionSettings_GetKeyLength(DocumentEncryptionSettingsHandle *handle, integer_type *result)

Length of the key for document encryption.

error_type DocumentEncryptionSettings_SetKeyLength(DocumentEncryptionSettingsHandle *handle, integer_type key_length)

Length of the key for document encryption.

error_type DocumentEncryptionSettings_GetUserAccessPermissions(DocumentEncryptionSettingsHandle *handle, UserAccessPermissionFlags *result)

Permissions for user, when opening the document with user password.

error_type DocumentEncryptionSettings_SetUserAccessPermissions(DocumentEncryptionSettingsHandle *handle, UserAccessPermissionFlags user_permissions)

Permissions for user, when opening the document with user password.

error_type DocumentEncryptionSettings_GetUserPassword(DocumentEncryptionSettingsHandle *handle, BufferHandle **result)

User password to be used for document encryption.

error_type DocumentEncryptionSettings_SetUserPassword(DocumentEncryptionSettingsHandle *handle, BufferHandle *user_password)

User password to be used for document encryption.

error_type DocumentEncryptionSettings_GetOwnerPassword(DocumentEncryptionSettingsHandle *handle, BufferHandle **result)

Owner password to be used for document encryption.

error_type DocumentEncryptionSettings_SetOwnerPassword(DocumentEncryptionSettingsHandle *handle, BufferHandle *owner_password)

Owner password to be used for document encryption.

error_type DocumentEncryptionSettings_ToUnknown(DocumentEncryptionSettingsHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type DocumentEncryptionSettings_FromUnknown(IUnknownHandle *handle, DocumentEncryptionSettingsHandle **result)

Convert IUnknownHandle to DocumentEncryptionSettingsHandle.

error_type DocumentEncryptionSettings_Release(DocumentEncryptionSettingsHandle *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

IUnknown_Release

class DocumentInfoHandle : public IUnknownHandle

#include <c_document_info.h>

Metadata for the document.

See also

DocumentHandle

Unnamed Group

error_type DocumentInfo_GetTitle(DocumentInfoHandle *handle, StringObjectHandle **result)

The document’s title.

error_type DocumentInfo_GetAuthor(DocumentInfoHandle *handle, StringObjectHandle **result)

The name of the person who created the document.

error_type DocumentInfo_GetSubject(DocumentInfoHandle *handle, StringObjectHandle **result)

The subject of the document.

error_type DocumentInfo_GetKeywords(DocumentInfoHandle *handle, StringObjectHandle **result)

Keywords associated with the document.

error_type DocumentInfo_GetCreator(DocumentInfoHandle *handle, StringObjectHandle **result)

If the document was converted to PDF from another format, the name of the conforming product that created the original document from which it was converted.

error_type DocumentInfo_GetProducer(DocumentInfoHandle *handle, StringObjectHandle **result)

If the document was converted to PDF from another format, the name of the conforming product that converted it to PDF.

error_type DocumentInfo_GetCreationDate(DocumentInfoHandle *handle, DateHandle **result)

The date and time the document was created.

error_type DocumentInfo_GetModificationDate(DocumentInfoHandle *handle, DateHandle **result)

The date and time the document was most recently modified.

error_type DocumentInfo_GetTrapped(DocumentInfoHandle *handle, DocumentTrappedType *result)

Indication whether the document has been modified to include trapping information (see 14.11.6, “Trapping Support”)

error_type DocumentInfo_ToUnknown(DocumentInfoHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type DocumentInfo_FromUnknown(IUnknownHandle *handle, DocumentInfoHandle **result)

Convert IUnknownHandle to DocumentInfoHandle.

error_type DocumentInfo_Release(DocumentInfoHandle *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

IUnknown_Release

class DocumentSignatureSettingsHandle : public IUnknownHandle

#include <c_document_signature_settings.h>

Group of settings controlling document’s digital signature.

See also

DigitalSignatureHandle

Unnamed Group

error_type DocumentSignatureSettings_Create(DocumentSignatureSettingsHandle **result)

Creates a new DocumentSignatureSettings instance.

error_type DocumentSignatureSettings_GetDigest(DocumentSignatureSettingsHandle *handle, MessageDigestAlgorithmType *result)

Message digest algorithm for calculation hash of the data to be signed.

error_type DocumentSignatureSettings_SetDigest(DocumentSignatureSettingsHandle *handle, MessageDigestAlgorithmType value)

Message digest algorithm for calculation hash of the data to be signed.

error_type DocumentSignatureSettings_GetSigningKey(DocumentSignatureSettingsHandle *handle, SigningKeyHandle **result)

Get handle to key used for calculating document signature value.

error_type DocumentSignatureSettings_SetSigningKey(DocumentSignatureSettingsHandle *handle, SigningKeyHandle *value)

Get handle to key used for calculating document signature value.

error_type DocumentSignatureSettings_GetName(DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle **result)

Set the name of the person or authority signing the document.

error_type DocumentSignatureSettings_SetName(DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle *value)

Set the name of the person or authority signing the document.

error_type DocumentSignatureSettings_GetLocation(DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle **result)

Get the CPU host name or physical location of the signing.

error_type DocumentSignatureSettings_SetLocation(DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle *value)

Get the CPU host name or physical location of the signing.

error_type DocumentSignatureSettings_GetReason(DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle **result)

Set the reason for the signing, such as (I agree…).

error_type DocumentSignatureSettings_SetReason(DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle *value)

Set the reason for the signing, such as (I agree…).

error_type DocumentSignatureSettings_GetSigningTime(DocumentSignatureSettingsHandle *handle, DateHandle **result)

The time of signing.

Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server. This value should be used only when the time of signing is not available in the signature.

error_type DocumentSignatureSettings_SetSigningTime(DocumentSignatureSettingsHandle *handle, DateHandle *value)

The time of signing.

error_type DocumentSignatureSettings_GetCertificate(DocumentSignatureSettingsHandle *handle, HexadecimalStringObjectHandle **result)

An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.

error_type DocumentSignatureSettings_SetCertificate(DocumentSignatureSettingsHandle *handle, HexadecimalStringObjectHandle *value)

An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.

error_type DocumentSignatureSettings_ToUnknown(DocumentSignatureSettingsHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type DocumentSignatureSettings_FromUnknown(IUnknownHandle *handle, DocumentSignatureSettingsHandle **result)

Convert IUnknownHandle to DocumentSignatureSettingsHandle.

error_type DocumentSignatureSettings_Release(DocumentSignatureSettingsHandle *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

IUnknown_Release

class InteractiveFormHandle : public IUnknownHandle

#include <c_interactive_forms.h>

An interactive form (PDF 1.2) - sometimes referred to as an AcroForm - is a collection of fields for gathering information interactively from the user.

For more details please visit section 12.7 - Interactive Forms.

Unnamed Group

error_type InteractiveForm_GetFields(InteractiveFormHandle *handle, FieldCollectionHandle **result)

An array of references to the document’s root fields.

error_type InteractiveForm_Release(InteractiveFormHandle *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

IUnknown_Release

class PageContentsHandle : public IUnknownHandle

#include <c_page_contents.h>

A content stream is a PDF stream object whose data consists of a sequence of instructions describing the graphical elements to be painted on a page.

See also

PageObjectHandle

Unnamed Group

error_type PageContents_GetInstructionCollection(PageContentsHandle *handle, ContentInstructionCollectionHandle **result)

Return collection of the content stream instructions.

error_type PageContents_RecalculateStreamData(PageContentsHandle *handle, boolean_type *result)

Updates the referenced stream content to reflect content operation changes.

error_type PageContents_GetBaseObject(PageContentsHandle *handle, ObjectHandle **result)

Switch object to low-level syntax API.

Useful for cases, where semantic API is not sufficient.

error_type PageContents_ToUnknown(PageContentsHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type PageContents_FromUnknown(IUnknownHandle *handle, PageContentsHandle **result)

Convert IUnknownHandle to PageContentsHandle.

error_type PageContents_Release(PageContentsHandle *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

IUnknown_Release

class PageLabelsHandle : public IUnknownHandle

#include <c_page_labels.h>

Collection of PageLabelHandle.

See also

CatalogHandle

Unnamed Group

error_type PageLabels_Contains(PageLabelsHandle *handle, size_type page_number, boolean_type *result)

Detemines if collection contains label for page number page_number.

error_type PageLabels_At(PageLabelsHandle *handle, size_type page_number, PageLabelHandle **result)

Get page label for page number page_number.

error_type PageLabels_Release(PageLabelsHandle *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

IUnknown_Release

class PageLabelHandle : public IUnknownHandle

#include <c_page_labels.h>

Page labels are used for numbering or otherwise identifying individual pages.

For more information please visit section 12.4.2 - Page Labels.

See also

PageLabelsHandle

Unnamed Group

error_type PageLabel_Prefix(PageLabelHandle *handle, StringObjectHandle **result)

The label prefix for page labels in this range.

error_type PageLabel_Start(PageLabelHandle *handle, IntegerObjectHandle **result)

The value of the numeric portion for the first page label in the range.

error_type PageLabel_Style(PageLabelHandle *handle, NumberingStyle *result)

The numbering style that shall be used for the numeric portion of each page label.

error_type PageLabel_Release(PageLabelHandle *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

IUnknown_Release

class PageObjectHandle : public IUnknownHandle

#include <c_page_object.h>

The leaves of the page tree are page objects, each of which is a dictionary specifying the attributes of a single page of the document.

See also

PageTreeHandle

Unnamed Group

error_type PageObject_CreateFromDocument(DocumentHandle *handle, PageObjectHandle **result)

Creates a new instance.

Function creates a new indirect dictionary with it’s type set to “Page”.

This new entry has to be manually added to document catalog’s page tree.

See also

PageTreeHandle

error_type PageObject_CreateFromObject(DictionaryObjectHandle *handle, PageObjectHandle **result)

Create a new PageObject from existing low-level syntax API object.

error_type PageObject_GetContents(PageObjectHandle *handle, PageContentsHandle **result)

A content stream (see 7.8.2, “Content Streams”) that shall describe the contents of this page. If this entry is absent, the page shall be empty.

error_type PageObject_GetParent(PageObjectHandle *handle, PageTreeHandle **result)

The page tree node that is the immediate parent of this page object.

error_type PageObject_GetResources(PageObjectHandle *handle, ResourceDictionaryHandle **result)

A dictionary containing any resources required by the page (see 7.8.3, “Resource Dictionaries”).

If the page requires no resources, the value of this entry shall be an empty dictionary. Omitting the entry entirely indicates that the resources shall be inherited from an ancestor node in the page tree.

error_type PageObject_GetAnnotations(PageObjectHandle *handle, PageAnnotationsHandle **result)

An array of annotation dictionaries that shall contain indirect references to all annotations associated with the page (see 12.5, “Annotations”).

error_type PageObject_GetMediaBox(PageObjectHandle *handle, RectangleHandle **result)

A rectangle expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed (see 14.11.2, “Page Boundaries”).

error_type PageObject_SetMediaBox(PageObjectHandle *handle, RectangleHandle *value)

A rectangle expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed (see 14.11.2, “Page Boundaries”).

error_type PageObject_GetBaseObject(PageObjectHandle *handle, DictionaryObjectHandle **result)

Switch object to low-level syntax API.

Useful for cases, where semantic API is not sufficient.

error_type PageObject_ToUnknown(PageObjectHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type PageObject_FromUnknown(IUnknownHandle *handle, PageObjectHandle **result)

Convert IUnknownHandle to PageObjectHandle.

error_type PageObject_Release(PageObjectHandle *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

IUnknown_Release

class PageTreeHandle : public IUnknownHandle

#include <c_page_tree.h>

The pages of a document are accessed through a structure known as the page tree, which defines the ordering of pages in the document.

See also

CatalogHandle

Unnamed Group

error_type PageTree_GetPageCount(PageTreeHandle *handle, size_type *result)

Get total number of pages in current document.

error_type PageTree_GetPage(PageTreeHandle *handle, size_type at, PageObjectHandle **result)

Get page at index at.

error_type PageTree_InsertPage(PageTreeHandle *handle, size_type at, PageObjectHandle *page)

Insert new page at index at.

The page tree is extended by inserting new element before the element at the specified position, effectively increasing the container by one.

error_type PageTree_AppendPage(PageTreeHandle *handle, PageObjectHandle *page)

Adds a new page at the end of the page tree, after its current last element.

error_type PageTree_RemovePage(PageTreeHandle *handle, size_type at)

Removed a page at index at.

This effectively reduces the container size by one.

error_type PageTree_ToUnknown(PageTreeHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type PageTree_FromUnknown(IUnknownHandle *handle, PageTreeHandle **result)

Convert IUnknownHandle to PageTreeHandle.

error_type PageTree_Release(PageTreeHandle *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

IUnknown_Release

class ResourceDictionaryHandle : public IUnknownHandle

#include <c_resource_dictionary.h>

A content stream’s named resources shall be defined by a resource dictionary, which shall enumerate the named resources needed by the operators in the content stream and the names by which they can be referred to.

See also

PageObjectHandle

Unnamed Group

error_type ResourceDictionary_GetFontMap(ResourceDictionaryHandle *handle, FontMapHandle **result)

A dictionary that maps resource names to font dictionaries.

error_type ResourceDictionary_ToUnknown(ResourceDictionaryHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type ResourceDictionary_FromUnknown(IUnknownHandle *handle, ResourceDictionaryHandle **result)

Convert IUnknownHandle to ResourceDictionaryHandle.

error_type ResourceDictionary_Release(ResourceDictionaryHandle *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

IUnknown_Release

class ViewerPreferencesHandle : public IUnknownHandle

#include <c_viewer_preferences.h>

Controlling the way the document shall be presented on the screen or in print.

See also

CatalogHandle

Unnamed Group

error_type ViewerPreferences_GetHideToolbar(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether to hide the conforming reader’s tool bars when the document is active.

error_type ViewerPreferences_GetHideMenubar(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether to hide the conforming reader’s menu bar when the document is active.

error_type ViewerPreferences_GetHideWindowUI(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.

error_type ViewerPreferences_GetFitWindow(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether to resize the document’s window to fit the size of the first displayed page.

error_type ViewerPreferences_GetCenterWindow(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether to position the document’s window in the center of the screen.

error_type ViewerPreferences_GetDisplayDocTitle(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary (see 14.3.3, “Document Information Dictionary”).

If false, the title bar should instead display the name of the PDF file containing the document.

error_type ViewerPreferences_GetNonFullScreenPageMode(ViewerPreferencesHandle *handle, NonFullScreenPageMode *result)

The document’s page mode, specifying how to display the document on exiting full-screen mode.

error_type ViewerPreferences_GetDirection(ViewerPreferencesHandle *handle, ReadingOrder *result)

The predominant reading order for text.

error_type ViewerPreferences_GetViewArea(ViewerPreferencesHandle *handle, NameObjectHandle **result)

The name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen.

error_type ViewerPreferences_GetViewClip(ViewerPreferencesHandle *handle, NameObjectHandle **result)

The name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen.

error_type ViewerPreferences_GetPrintArea(ViewerPreferencesHandle *handle, NameObjectHandle **result)

The name of the page boundary representing the area of a page that shall be rendered when printing the document.

error_type ViewerPreferences_GetPrintClip(ViewerPreferencesHandle *handle, NameObjectHandle **result)

The name of the page boundary to which the contents of a page shall be clipped when printing the document.

error_type ViewerPreferences_GetPrintScaling(ViewerPreferencesHandle *handle, PrintScaling *result)

The page scaling option that shall be selected when a print dialog is displayed for this document.

error_type ViewerPreferences_GetDuplex(ViewerPreferencesHandle *handle, Duplex *result)

The paper handling option that shall be used when printing the file from the print dialog.

error_type ViewerPreferences_GetPickTrayByPDFSize(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)

A flag specifying whether the PDF page size shall be used to select the input paper tray.

error_type ViewerPreferences_GetPrintPageRange(ViewerPreferencesHandle *handle, PageRangeHandle **result)

The page numbers used to initialize the print dialog box when the file is printed.

error_type ViewerPreferences_GetNumCopies(ViewerPreferencesHandle *handle, IntegerObjectHandle **result)

The number of copies that shall be printed when the print dialog is opened for this file.

error_type ViewerPreferences_Release(ViewerPreferencesHandle *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

IUnknown_Release

class PageRangeHandle : public IUnknownHandle

#include <c_viewer_preferences.h>

Collection of PageSubRangeHandle.

See also

ViewerPreferencesHandle

Unnamed Group

error_type PageRange_GetSize(PageRangeHandle *handle, size_type *result)

Get size of the collections.

error_type PageRange_GetSubrange(PageRangeHandle *handle, size_type at, PageSubRangeHandle **result)

Get sub-range at index at.

error_type PageRange_Release(PageRangeHandle *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

IUnknown_Release

class PageSubRangeHandle : public IUnknownHandle

#include <c_viewer_preferences.h>

Specifies first and last page number of defined range.

See also

PageRangeHandle

Unnamed Group

error_type PageSubRange_GetFirstPage(PageSubRangeHandle *handle, IntegerObjectHandle **result)

Get the index of first last page in the sub-range.

error_type PageSubRange_GetLastPage(PageSubRangeHandle *handle, IntegerObjectHandle **result)

Get the index of last last page in the sub-range.

error_type PageSubRange_Release(PageSubRangeHandle *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

IUnknown_Release

Common Data Structures

class DateHandle : public IUnknownHandle

#include <c_date.h>

Represents a reference to a particular day represented within a calendar system.

Unnamed Group

error_type Date_CreateEmpty(DateHandle **result)

Create a new blank date instance.

error_type Date_CreateCurrent(DateHandle **result)

Get current date in UTC format.

error_type Date_GetYear(DateHandle *handle, integer_type *result)

Get year represented by this object.

error_type Date_SetYear(DateHandle *handle, integer_type value)

Get year represented by this object.

error_type Date_GetMonth(DateHandle *handle, integer_type *result)

Get month in specified year represented by this object. Range of values (1-12)

error_type Date_SetMonth(DateHandle *handle, integer_type value)

Get month in specified year represented by this object. Range of values (1-12)

error_type Date_GetDay(DateHandle *handle, integer_type *result)

Get day index in month represented by this object. Range of values (1-31)

error_type Date_SetDay(DateHandle *handle, integer_type value)

Get day index in month represented by this object. Range of values (1-31)

error_type Date_GetHour(DateHandle *handle, integer_type *result)

Get hours in day represented by this object. Range of values (0-23)

error_type Date_SetHour(DateHandle *handle, integer_type value)

Get hours in day represented by this object. Range of values (0-23)

error_type Date_GetMinute(DateHandle *handle, integer_type *result)

Get minutes represented by this object. Range of values (0-59)

error_type Date_SetMinute(DateHandle *handle, integer_type value)

Get minutes represented by this object. Range of values (0-59)

error_type Date_GetSecond(DateHandle *handle, integer_type *result)

Get seconds represented by this object. Range of values (0-59)

error_type Date_SetSecond(DateHandle *handle, integer_type value)

Get seconds represented by this object. Range of values (0-59)

error_type Date_GetTimezone(DateHandle *handle, TimezoneType *result)

Relationship of local time to Universal Time (UT).

error_type Date_SetTimezone(DateHandle *handle, TimezoneType value)

Relationship of local time to Universal Time (UT).

error_type Date_GetHourOffset(DateHandle *handle, integer_type *result)

Get hour offset represented by this object. Range of values (0-23)

error_type Date_SetHourOffset(DateHandle *handle, integer_type value)

Get hour offset represented by this object. Range of values (0-23)

error_type Date_GetMinuteOffset(DateHandle *handle, integer_type *result)

Get minute offset represented by this object. Range of values (0-59)

error_type Date_SetMinuteOffset(DateHandle *handle, integer_type value)

Get minute offset represented by this object. Range of values (0-59)

error_type Date_ToUnknown(DateHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Date_FromUnknown(IUnknownHandle *handle, DateHandle **result)

Convert IUnknownHandle to DateHandle.

error_type Date_Release(DateHandle *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

IUnknown_Release

class RectangleHandle : public IUnknownHandle

#include <c_rectangle.h>

Represents rectangle in 2D space.

Unnamed Group

error_type Rectangle_Create(RectangleHandle **result)

Create a new rectangle with default values.

error_type Rectangle_GetLowerLeftX(RectangleHandle *handle, bigint_type *result)

Get X-coordinate of lower-left corner.

error_type Rectangle_SetLowerLeftX(RectangleHandle *handle, bigint_type data)

Set X-coordinate of lower-left corner.

error_type Rectangle_GetLowerLeftY(RectangleHandle *handle, bigint_type *result)

Get Y-coordinate of lower-left corner.

error_type Rectangle_SetLowerLeftY(RectangleHandle *handle, bigint_type data)

Set Y-coordinate of lower-left corner.

error_type Rectangle_GetUpperRightX(RectangleHandle *handle, bigint_type *result)

Get X-coordinate of upper-right corner.

error_type Rectangle_SetUpperRightX(RectangleHandle *handle, bigint_type data)

Set X-coordinate of upper-right corner.

error_type Rectangle_GetUpperRightY(RectangleHandle *handle, bigint_type *result)

Get Y-coordinate of upper-right corner.

error_type Rectangle_SetUpperRightY(RectangleHandle *handle, bigint_type data)

Set Y-coordinate of upper-right corner.

error_type Rectangle_ToUnknown(RectangleHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Rectangle_FromUnknown(IUnknownHandle *handle, RectangleHandle **result)

Convert IUnknownHandle to ObjectHandle.

error_type Rectangle_Release(RectangleHandle *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

IUnknown_Release

Fonts

enum FontType

Types of fonts.

Values:

enumerator FontType_Undefined

enumerator FontType_Type0

A font composed of glyphs from a descendant CIDFont.

See also

Type0FontHandle

enumerator FontType_Type1

A font that defines glyph shapes using Type 1 font technology.

enumerator FontType_MMType1

enumerator FontType_Type3

A font that defines glyphs with streams of PDF graphics operators.

enumerator FontType_TrueType

enumerator FontType_CIDFontType0

enumerator FontType_CIDFontType2

class FontHandle : public IUnknownHandle

#include <c_font.h>

Base class for all fonts in to representable inside a PDF document.

For more details please visit section 9.5 - Introduction to Font Data Structures.

Subclassed by Type0FontHandle

Unnamed Group

error_type Font_CreateFromObject(DictionaryObjectHandle *handle, FontHandle **result)

Create new font object from the specified dictionary.

error_type Font_GetFontType(FontHandle *handle, FontType *result)

Get derived type of current object.

error_type Font_GetUnicodeMap(FontHandle *handle, UnicodeCharacterMapHandle **result)

A stream containing a CMap file that maps character codes to Unicode values (see 9.10, “Extraction of Text Content”).

error_type Font_ToUnknown(FontHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Font_FromUnknown(IUnknownHandle *handle, FontHandle **result)

Convert IUnknownHandle to FontHandle.

error_type Font_Release(FontHandle *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

IUnknown_Release

class Type0FontHandle : public FontHandle

#include <c_font.h>

A font composed of glyphs from a descendant CIDFont.

For more details please visit section 9.7 - Composite Fonts.

Unnamed Group

error_type Type0Font_ToFont(Type0FontHandle *handle, FontHandle **result)

Reinterpret current object as FontHandle.

error_type Type0Font_FromFont(FontHandle *handle, Type0FontHandle **result)

Convert ObjectHandle to Type0FontHandle.

error_type Type0Font_Release(Type0FontHandle *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

IUnknown_Release

class FontMapHandle : public IUnknownHandle

#include <c_font_map.h>

A dictionary that maps resource names to font dictionaries.

See also

ResourceDictionaryHandle

Unnamed Group

error_type FontMap_Contains(FontMapHandle *handle, const NameObjectHandle *key_handle, boolean_type *result)

Determine if collection contains key key_handle.

error_type FontMap_Find(FontMapHandle *handle, const NameObjectHandle *key_handle, FontHandle **result)

Find mapped value for key key_handle.

error_type FontMap_ToUnknown(FontMapHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type FontMap_FromUnknown(IUnknownHandle *handle, FontMapHandle **result)

Convert IUnknownHandle to FontMapHandle.

error_type FontMap_Release(FontMapHandle *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

IUnknown_Release

Fields

enum FieldType

Available types of fields.

Values:

enumerator FieldType_Undefined

enumerator FieldType_NonTerminal

Many field attributes are inheritable, meaning that if they are not explicitly specified for a given field, their values are taken from those of its parent in the field hierarchy.

See also

NonTerminalFieldHandle

enumerator FieldType_Button

A button field represents an interactive control on the screen that the user can manipulate with the mouse.

See also

ButtonFieldHandle

enumerator FieldType_Text

A text field is a box or space for text fill-in data typically entered from a keyboard.

See also

TextFieldHandle

enumerator FieldType_Choice

A choice field contains several text items, one or more of which shall be selected as the field value.

See also

ChoiceFieldHandle

enumerator FieldType_Signature

A signature field (PDF 1.3) is a form field that contains a digital signature.

See also

SignatureFieldHandle

class FieldCollectionHandle : public IUnknownHandle

#include <c_fields.h>

Collection of FieldHandle.

Unnamed Group

error_type FieldCollection_GetSize(FieldCollectionHandle *handle, size_type *result)

Get size of field collection.

error_type FieldCollection_At(FieldCollectionHandle *handle, size_type at, FieldHandle **result)

Get single field from array at specific position.

error_type FieldCollection_Release(FieldCollectionHandle *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

IUnknown_Release

class FieldHandle : public IUnknownHandle

#include <c_fields.h>

Base class for all fields.

Subclassed by ButtonFieldHandle, ChoiceFieldHandle, NonTerminalFieldHandle, SignatureFieldHandle, TextFieldHandle

Unnamed Group

error_type Field_CreateFromDictionary(DictionaryObjectHandle *dictionary, FieldHandle **result)

Create a field from a dictionary object. The field type is determined by the /FT entry in the dictionary.

error_type Field_GetType(FieldHandle *handle, FieldType *result)

Return type of field. Result can be used to convert to derived type.

error_type Field_ToButton(FieldHandle *handle, ButtonFieldHandle **result)

Reinterpret current object as ButtonFieldHandle.

Deprecated:

Use ButtonField_FromField instead

error_type Field_ToText(FieldHandle *handle, TextFieldHandle **result)

Reinterpret current object as TextFieldHandle.

Deprecated:

Use TextField_FromField instead

error_type Field_ToChoice(FieldHandle *handle, ChoiceFieldHandle **result)

Reinterpret current object as ChoiceFieldHandle.

Deprecated:

Use ChoiceField_FromField instead

error_type Field_ToSignature(FieldHandle *handle, SignatureFieldHandle **result)

Reinterpret current object as SignatureFieldHandle.

Deprecated:

Use SignatureField_FromField instead

error_type Field_Release(FieldHandle *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

IUnknown_Release

class NonTerminalFieldHandle : public FieldHandle

#include <c_fields.h>

Many field attributes are inheritable, meaning that if they are not explicitly specified for a given field, their values are taken from those of its parent in the field hierarchy.

class ButtonFieldHandle : public FieldHandle

#include <c_fields.h>

A button field represents an interactive control on the screen that the user can manipulate with the mouse.

Unnamed Group

error_type ButtonField_ToField(ButtonFieldHandle *handle, FieldHandle **result)

Reinterpret current object as FieldHandle.

error_type ButtonField_FromField(FieldHandle *handle, ButtonFieldHandle **result)

Convert FieldHandle to ButtonFieldHandle.

error_type ButtonField_Release(ButtonFieldHandle *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

IUnknown_Release

class TextFieldHandle : public FieldHandle

#include <c_fields.h>

A text field is a box or space for text fill-in data typically entered from a keyboard.

Unnamed Group

error_type TextField_ToField(TextFieldHandle *handle, FieldHandle **result)

Reinterpret current object as FieldHandle.

error_type TextField_FromField(FieldHandle *handle, TextFieldHandle **result)

Convert FieldHandle to TextFieldHandle.

error_type TextField_Release(TextFieldHandle *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

IUnknown_Release

class ChoiceFieldHandle : public FieldHandle

#include <c_fields.h>

A choice field contains several text items, one or more of which shall be selected as the field value.

Unnamed Group

error_type ChoiceField_ToField(ChoiceFieldHandle *handle, FieldHandle **result)

Reinterpret current object as FieldHandle.

error_type ChoiceField_FromField(FieldHandle *handle, ChoiceFieldHandle **result)

Convert FieldHandle to ChoiceFieldHandle.

error_type ChoiceField_Release(ChoiceFieldHandle *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

IUnknown_Release

class SignatureFieldHandle : public FieldHandle

#include <c_fields.h>

A signature field (PDF 1.3) is a form field that contains a digital signature.

See also

DigitalSignatureHandle

Unnamed Group

error_type SignatureField_GetValue(SignatureFieldHandle *handle, DigitalSignatureHandle **result)

A signature dictionary containing the signature and specifying various attributes of the signature field.

error_type SignatureField_ToField(SignatureFieldHandle *handle, FieldHandle **result)

Reinterpret current object as FieldHandle.

error_type SignatureField_FromField(FieldHandle *handle, SignatureFieldHandle **result)

Convert FieldHandle to SignatureFieldHandle.

error_type SignatureField_Release(SignatureFieldHandle *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

IUnknown_Release

Outline

enum OutlineType

Available types of outlines.

Values:

enumerator OutlineType_Undefined

enumerator OutlineType_Outline

The root of a document’s outline hierarchy.

See also

OutlineHandle

enumerator OutlineType_Item

Child element within tree-structured hierarchy of outline items.

See also

OutlineItemHandle

class OutlineBaseHandle : public IUnknownHandle

#include <c_outline.h>

Base class for document outlines.

See also

CatalogHandle

Subclassed by OutlineHandle, OutlineItemHandle

Unnamed Group

error_type OutlineBase_GetOutlineType(OutlineBaseHandle *handle, OutlineType *result)

Get derived type of current object.

error_type OutlineBase_ToUnknown(OutlineBaseHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type OutlineBase_FromUnknown(IUnknownHandle *handle, OutlineBaseHandle **result)

Convert IUnknownHandle to CatalogHandle.

error_type OutlineBase_Release(OutlineBaseHandle *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

IUnknown_Release

class OutlineHandle : public OutlineBaseHandle

#include <c_outline.h>

The root of a document’s outline hierarchy.

Unnamed Group

error_type Outline_GetFirst(OutlineHandle *handle, OutlineItemHandle **result)

An outline item dictionary representing the first top-level item in the outline.

error_type Outline_GetLast(OutlineHandle *handle, OutlineItemHandle **result)

An outline item dictionary representing the last top-level item in the outline.

error_type Outline_GetCount(OutlineHandle *handle, IntegerObjectHandle **result)

Total number of visible outline items at all levels of the outline.

The value cannot be negative.

This entry shall be omitted if there are no open outline items.

error_type Outline_ToOutlineBase(OutlineHandle *handle, OutlineBaseHandle **result)

Reinterpret current object as OutlineBaseHandle.

error_type Outline_FromOutlineBase(OutlineBaseHandle *handle, OutlineHandle **result)

Convert OutlineBaseHandle to OutlineItemHandle.

error_type Outline_Release(OutlineHandle *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

IUnknown_Release

class OutlineItemHandle : public OutlineBaseHandle

#include <c_outline.h>

Child element within tree-structured hierarchy of outline items.

Unnamed Group

error_type OutlineItem_GetTitle(OutlineItemHandle *handle, StringObjectHandle **result)

The text that shall be displayed on the screen for this item.

error_type OutlineItem_GetParent(OutlineItemHandle *handle, OutlineBaseHandle **result)

The parent of this item in the outline hierarchy.

error_type OutlineItem_GetPrev(OutlineItemHandle *handle, OutlineItemHandle **result)

The previous item at this outline level.

error_type OutlineItem_GetNext(OutlineItemHandle *handle, OutlineItemHandle **result)

The next item at this outline level.

error_type OutlineItem_GetFirst(OutlineItemHandle *handle, OutlineItemHandle **result)

The first of this item’s immediate children in the outline hierarchy.

error_type OutlineItem_GetLast(OutlineItemHandle *handle, OutlineItemHandle **result)

The last of this item’s immediate children in the outline hierarchy.

error_type OutlineItem_GetCount(OutlineItemHandle *handle, IntegerObjectHandle **result)

Sum of the number of visible descendent outline items at all levels.

error_type OutlineItem_GetDestination(OutlineItemHandle *handle, DestinationHandle **result)

A destination to be displayed when this outline item is activated.

error_type OutlineItem_GetColor(OutlineItemHandle *handle, OutlineItemColorHandle **result)

Representing the components in the DeviceRGB colour space of the colour that shall be used for the outline entry’s text.

error_type OutlineItem_GetFlags(OutlineItemHandle *handle, OutlineItemFlagsHandle **result)

A set of flags specifying style characteristics for displaying the outline item’s text.

error_type OutlineItem_ToOutlineBase(OutlineItemHandle *handle, OutlineBaseHandle **result)

Reinterpret current object as OutlineBaseHandle.

error_type OutlineItem_FromOutlineBase(OutlineBaseHandle *handle, OutlineItemHandle **result)

Convert OutlineBaseHandle to OutlineItemHandle.

error_type OutlineItem_Release(OutlineItemHandle *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

IUnknown_Release

class OutlineItemColorHandle : public IUnknownHandle

#include <c_outline.h>

Representing the components in the DeviceRGB colour space of the colour that shall be used for the outline entry’s text.

Unnamed Group

error_type OutlineItemColor_GetRed(OutlineItemColorHandle *handle, IntegerObjectHandle **result)

Get red component of defined RGB color.

error_type OutlineItemColor_GetGreen(OutlineItemColorHandle *handle, IntegerObjectHandle **result)

Get green component of defined RGB color.

error_type OutlineItemColor_GetBlue(OutlineItemColorHandle *handle, IntegerObjectHandle **result)

Get blue component of defined RGB color.

error_type OutlineItemColor_Release(OutlineItemColorHandle *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

IUnknown_Release

class OutlineItemFlagsHandle : public IUnknownHandle

#include <c_outline.h>

A set of flags specifying style characteristics for displaying the outline item’s text.

Unnamed Group

error_type OutlineItemFlags_IsItalic(OutlineItemFlagsHandle *handle, boolean_type *result)

Determine if the outline item shall be displayed in italic.

error_type OutlineItemFlags_IsBold(OutlineItemFlagsHandle *handle, boolean_type *result)

Determine if the outline item shall be displayed in bold.

error_type OutlineItemFlags_Release(OutlineItemFlagsHandle *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

IUnknown_Release

Annotations

enum AnnotationType

Derived types of AnnotationHandle.

Values:

enumerator AnnotationType_Undefined

Undefined unitialized default value, triggers error when used.

enumerator AnnotationType_Text

A text annotation represents a “sticky note” attached to a point in the PDF document.

enumerator AnnotationType_Link

A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed

enumerator AnnotationType_FreeText

A free text annotation (PDF 1.3) displays text directly on the page.

enumerator AnnotationType_Line

The purpose of a line annotation (PDF 1.3) is to display a single straight line on the page.

enumerator AnnotationType_Square

Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page.

enumerator AnnotationType_Circle

Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page.

enumerator AnnotationType_Polygon

Polygon annotations (PDF 1.5) display closed polygons on the page.

enumerator AnnotationType_PolyLine

Polyline annotations (PDF 1.5) are similar to polygons, except that the first and last vertex are not implicitly connected.

enumerator AnnotationType_Highlight

Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4) in the text of a document.

enumerator AnnotationType_Underline

Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4) in the text of a document.

enumerator AnnotationType_Squiggly

Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4) in the text of a document.

enumerator AnnotationType_StrikeOut

Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4) in the text of a document.

enumerator AnnotationType_RubberStamp

A rubber stamp annotation (PDF 1.3) displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.

enumerator AnnotationType_Caret

A caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

enumerator AnnotationType_Ink

An ink annotation (PDF 1.3) represents a freehand “scribble” composed of one or more disjoint paths.

enumerator AnnotationType_Popup

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing.

enumerator AnnotationType_FileAttachment

A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file.

enumerator AnnotationType_Sound

A sound annotation (PDF 1.2) shall be analogous to a text annotation except that instead of a text note, it contains sound recorded from the computer’s microphone or imported from a file.

enumerator AnnotationType_Movie

A movie annotation (PDF 1.2) contains animated graphics and sound to be presented on the computer screen and through the speakers.

enumerator AnnotationType_Widget

Interactive forms use widget annotations (PDF 1.2) to represent the appearance of fields and to manage user interactions.

enumerator AnnotationType_Screen

A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played.

enumerator AnnotationType_PrinterMark

A printer’s mark annotation (PDF 1.4) represents a graphic symbol, such as a registration target,colour bar, or cut mark, that may be added to a page to assist production personnel in identifying components of a multiple-plate job and maintaining consistent output during production.

enumerator AnnotationType_TrapNetwork

A trap network annotation (PDF 1.3) may be used to define the trapping characteristics for a page of a PDF document.

enumerator AnnotationType_Watermark

A watermark annotation (PDF 1.6) shall be used to represent graphics that shall be printed at a fixed size and position on a page, regardless of the dimensions of the printed page.

enumerator AnnotationType_TripleD

3D annotations (PDF 1.6) are the means by which 3D artwork shall be represented in a PDF document.

enumerator AnnotationType_Redaction

A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document.

class PageAnnotationsHandle : public IUnknownHandle

#include <c_annotations.h>

An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle associated with the page.

See also

PageObjectHandle

Unnamed Group

error_type PageAnnotations_GetSize(PageAnnotationsHandle *handle, size_type *result)

Get size of annotation array.

error_type PageAnnotations_At(PageAnnotationsHandle *handle, size_type at, AnnotationHandle **result)

Get single annotation from array at specific position.

Parameters:

• handle – a handle to annotation collection

• at – position of the element in the handle collection

• result – a pointer to variable, that will contain annotation upon success, unchanged on failure

error_type PageAnnotations_ToUnknown(PageAnnotationsHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type PageAnnotations_FromUnknown(IUnknownHandle *handle, PageAnnotationsHandle **result)

Convert IUnknownHandle to PageAnnotationsHandle.

error_type PageAnnotations_Release(PageAnnotationsHandle *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

IUnknown_Release

class AnnotationHandle : public IUnknownHandle

#include <c_annotations.h>

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

Subclassed by LinkAnnotationHandle

Unnamed Group

error_type Annotation_GetAnnotationType(AnnotationHandle *handle, AnnotationType *result)

Get annotation type of object handle.

Parameters:

• handle – a handle to the annotation class

• result – a pointer to variable will be filled with annotation type upon success, unchanged on failure

error_type Annotation_ToUnknown(AnnotationHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Annotation_FromUnknown(IUnknownHandle *handle, AnnotationHandle **result)

Convert IUnknownHandle to PageAnnotationsHandle.

error_type Annotation_Release(AnnotationHandle *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

IUnknown_Release

class LinkAnnotationHandle : public AnnotationHandle

#include <c_annotations.h>

A link annotation represents either a hypertext link to a DestinationHandle elsewhere in the document or an Action to be performed.

For more details please visit section 12.5.6.5 - Link Annotations.

Unnamed Group

error_type LinkAnnotation_GetDestination(LinkAnnotationHandle *handle, DestinationHandle **result)

A destination that shall be displayed when the annotation is activated.

error_type LinkAnnotation_ToBaseAnnotation(LinkAnnotationHandle *handle, AnnotationHandle **result)

Reinterpret current object as IUnknownHandle.

error_type LinkAnnotation_FromBaseAnnotation(AnnotationHandle *handle, LinkAnnotationHandle **result)

Convert IUnknownHandle to LinkAnnotationHandle.

error_type LinkAnnotation_Release(LinkAnnotationHandle *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

IUnknown_Release

Destinations

enum DestinationType

Available destination types.

Values:

enumerator DestinationType_Undefined

enumerator DestinationType_XYZ

Display the page designated by page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom.

enumerator DestinationType_Fit

Display the page designated by page, with its contents magnified just enough to fit the entire page within the window both horizontally and vertically.

If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

enumerator DestinationType_FitHorizontal

Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window.

enumerator DestinationType_FitVertical

Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window.

enumerator DestinationType_FitRectangle

Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically.

If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

enumerator DestinationType_FitBoundingBox

Display the page designated by page, with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically.

If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.

enumerator DestinationType_FitBoundingBoxHorizontal

Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.

enumerator DestinationType_FitBoundingBoxVertical

Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window.

class DestinationHandle : public IUnknownHandle

#include <c_destinations.h>

Base class for all destinations.

Subclassed by FitBoundingBoxDestinationHandle, FitBoundingBoxHorizontalDestinationHandle, FitBoundingBoxVerticalDestinationHandle, FitDestinationHandle, FitHorizontalDestinationHandle, FitRectangleDestinationHandle, FitVerticalDestinationHandle, XYZDestinationHandle

Unnamed Group

error_type Destination_CreateFromArray(ArrayObjectHandle *array_handle, DestinationHandle **result)

Create a destination from an array object.

Array format: [page /Type …] The array should contain at least the page reference and destination type.

Parameters:

• array_handle – Array object containing destination parameters

• result – Pointer to receive the created destination handle

Returns:

VANILLAPDF_ERROR_SUCCESS on success, error otherwise

error_type Destination_CreateFromDictionary(DictionaryObjectHandle *dict_handle, DestinationHandle **result)

Create a destination from a dictionary object.

Dictionary format: {/D [page /Type …]} The dictionary should contain a /D entry with the destination array.

Parameters:

• dict_handle – Dictionary object containing /D entry with destination parameters

• result – Pointer to receive the created destination handle

Returns:

VANILLAPDF_ERROR_SUCCESS on success, error otherwise

error_type Destination_GetDestinationType(DestinationHandle *handle, DestinationType *result)

Get the type of destination to determine available parameters.

error_type Destination_GetPageNumber(DestinationHandle *handle, ObjectHandle **result)

The page of the document that shall be displayed.

The object type shall be either IntegerObjectHandle or IndirectReferenceObjectHandle.

IntegerObjectHandle means index in document’s page tree.

IndirectReferenceObjectHandle means it is indirect reference to PageObjectHandle representing the destination page.

See also

PageTreeHandle

error_type Destination_ToUnknown(DestinationHandle *handle, IUnknownHandle **result)

Reinterpret current object as IUnknownHandle.

error_type Destination_FromUnknown(IUnknownHandle *handle, DestinationHandle **result)

Convert IUnknownHandle to DestinationHandle.

class XYZDestinationHandle : public DestinationHandle

#include <c_destinations.h>

XYZ destination with optional left, top, and zoom parameters.

Unnamed Group

error_type XYZDestination_FromDestination(DestinationHandle *handle, XYZDestinationHandle **result)

Convert destination to XYZ destination if the type matches.

Returns:

VANILLAPDF_ERROR_SUCCESS if destination is XYZ type, error otherwise

error_type XYZDestination_ToDestination(XYZDestinationHandle *handle, DestinationHandle **result)

Convert XYZ destination back to base destination.

error_type XYZDestination_GetLeft(XYZDestinationHandle *handle, ObjectHandle **result)

Get the left coordinate for XYZ destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if left coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type XYZDestination_GetTop(XYZDestinationHandle *handle, ObjectHandle **result)

Get the top coordinate for XYZ destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if top coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type XYZDestination_GetZoom(XYZDestinationHandle *handle, ObjectHandle **result)

Get the zoom factor for XYZ destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if zoom factor is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type XYZDestination_Release(XYZDestinationHandle *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

IUnknown_Release

class FitDestinationHandle : public DestinationHandle

#include <c_destinations.h>

Fit destination that fits the entire page within the window.

Unnamed Group

error_type FitDestination_FromDestination(DestinationHandle *handle, FitDestinationHandle **result)

Convert destination to Fit destination if the type matches.

Returns:

VANILLAPDF_ERROR_SUCCESS if destination is Fit type, error otherwise

error_type FitDestination_ToDestination(FitDestinationHandle *handle, DestinationHandle **result)

Convert Fit destination back to base destination.

error_type FitDestination_Release(FitDestinationHandle *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

IUnknown_Release

class FitHorizontalDestinationHandle : public DestinationHandle

#include <c_destinations.h>

FitH destination with vertical coordinate at top edge.

Unnamed Group

error_type FitHorizontalDestination_GetTop(FitHorizontalDestinationHandle *handle, ObjectHandle **result)

Get the top coordinate for FitHorizontal destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if top coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

class FitVerticalDestinationHandle : public DestinationHandle

#include <c_destinations.h>

FitV destination with horizontal coordinate at left edge.

Unnamed Group

error_type FitVerticalDestination_GetLeft(FitVerticalDestinationHandle *handle, ObjectHandle **result)

Get the left coordinate for FitVertical destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if left coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

class FitRectangleDestinationHandle : public DestinationHandle

#include <c_destinations.h>

FitR destination that fits specified rectangle within window.

Unnamed Group

error_type FitRectangleDestination_GetLeft(FitRectangleDestinationHandle *handle, ObjectHandle **result)

Get the left coordinate for FitRectangle destination.

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if left coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type FitRectangleDestination_GetBottom(FitRectangleDestinationHandle *handle, ObjectHandle **result)

Get the bottom coordinate for FitRectangle destination.

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if bottom coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type FitRectangleDestination_GetRight(FitRectangleDestinationHandle *handle, ObjectHandle **result)

Get the right coordinate for FitRectangle destination.

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if right coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type FitRectangleDestination_GetTop(FitRectangleDestinationHandle *handle, ObjectHandle **result)

Get the top coordinate for FitRectangle destination.

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if top coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

class FitBoundingBoxDestinationHandle : public DestinationHandle

#include <c_destinations.h>

FitB destination that fits bounding box within window.

class FitBoundingBoxHorizontalDestinationHandle : public DestinationHandle

#include <c_destinations.h>

FitBH destination with vertical coordinate at top of bounding box.

Unnamed Group

error_type FitBoundingBoxHorizontalDestination_GetTop(FitBoundingBoxHorizontalDestinationHandle *handle, ObjectHandle **result)

Get the top coordinate for FitBoundingBoxHorizontal destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if top coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

class FitBoundingBoxVerticalDestinationHandle : public DestinationHandle

#include <c_destinations.h>

FitBV destination with horizontal coordinate at left of bounding box.

Unnamed Group

error_type FitBoundingBoxVerticalDestination_GetLeft(FitBoundingBoxVerticalDestinationHandle *handle, ObjectHandle **result)

Get the left coordinate for FitBoundingBoxVertical destination (null means no change).

Returns:

VANILLAPDF_ERROR_OBJECT_MISSING if left coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

error_type Destination_Release(DestinationHandle *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

IUnknown_Release

class NamedDestinationsHandle : public IUnknownHandle

#include <c_destinations.h>

A map of unique names mapped to their associated a DestinationHandle.

For more details please visit section 12.3.2.3 - Named Destinations.

Unnamed Group

error_type NamedDestinations_Contains(NamedDestinationsHandle *handle, const NameObjectHandle *name, boolean_type *result)

Determine if current map contains name.

error_type NamedDestinations_Find(NamedDestinationsHandle *handle, const NameObjectHandle *name, DestinationHandle **result)

Find mapped value for key name.

Prefer using NamedDestinations_Contains for validations.

This function throws internal exception on failure, which may render it slower.

error_type NamedDestinations_Release(NamedDestinationsHandle *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

IUnknown_Release