CDocumentMetadata_interface.h File Reference

Interface for CDocumentMetadata wrapper. More...

Go to the source code of this file.

Functions
CMetadataInfo	CDocumentMetadata_GetMetadataInfo (const CDocumentMetadata argCDocumentMetadata, idrs_exception *pargException)
	Gets the MetadataInfo property value.
void	CDocumentMetadata_SetMetadataInfo (CDocumentMetadata argCDocumentMetadata, const CMetadataInfo argMetadataInfo, idrs_exception *pargException)
	Sets the MetadataInfo property value.
CPageBookmarkArray	CDocumentMetadata_GetBookmarks (const CDocumentMetadata argCDocumentMetadata, idrs_exception *pargException)
	Returns the page's bookmarks.
void	CDocumentMetadata_SetBookmarks (CDocumentMetadata argCDocumentMetadata, const CPageBookmarkArray xBookmarks, idrs_exception *pargException)
	Sets the page's bookmarks.
CDigitalSignatureArray	CDocumentMetadata_GetDigitalSignatures (const CDocumentMetadata argCDocumentMetadata, idrs_exception *pargException)
	Get the digital signatures associated to the ouput pdf document.
void	CDocumentMetadata_SetDigitalSignatures (CDocumentMetadata argCDocumentMetadata, const CDigitalSignatureArray xDigitalSignatures, idrs_exception *pargException)
	Set the digital signatures associated to the ouput pdf document.
CAttachmentArray	CDocumentMetadata_GetAttachments (const CDocumentMetadata argCDocumentMetadata, idrs_exception *pargException)
	Gets the array of attachments to add to the output PDF.
void	CDocumentMetadata_SetAttachments (CDocumentMetadata argCDocumentMetadata, const CAttachmentArray argAttachmentArray, idrs_exception *pargException)
	Sets the array of attachments to add to the output PDF.
CDocumentMetadata	CDocumentMetadata_Create (idrs_exception *pargException)
	Creates a new CDocumentMetadata instance.
void	CDocumentMetadata_Destroy (CDocumentMetadata argCDocumentMetadata, idrs_exception *pargException)
	Destroys a CDocumentMetadata handle.

Detailed Description

Interface for CDocumentMetadata wrapper.

Function Documentation

CDocumentMetadata_Create()

CDocumentMetadata CDocumentMetadata_Create

(

idrs_exception *

pargException

)

Creates a new CDocumentMetadata instance.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_Destroy()

void CDocumentMetadata_Destroy	(	CDocumentMetadata	argCDocumentMetadata,
		idrs_exception *	pargException
	)

Destroys a CDocumentMetadata handle.

Parameters

argCDocumentMetadata	CDocumentMetadata handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_GetAttachments()

CAttachmentArray CDocumentMetadata_GetAttachments	(	const CDocumentMetadata	argCDocumentMetadata,
		idrs_exception *	pargException
	)

Gets the array of attachments to add to the output PDF.

Returns

The array of attachments

Parameters

argCDocumentMetadata	CDocumentMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_GetBookmarks()

CPageBookmarkArray CDocumentMetadata_GetBookmarks	(	const CDocumentMetadata	argCDocumentMetadata,
		idrs_exception *	pargException
	)

Returns the page's bookmarks.

Parameters

argCDocumentMetadata	CDocumentMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_GetDigitalSignatures()

CDigitalSignatureArray CDocumentMetadata_GetDigitalSignatures	(	const CDocumentMetadata	argCDocumentMetadata,
		idrs_exception *	pargException
	)

Get the digital signatures associated to the ouput pdf document.

Returns

the digital signatures array

Parameters

argCDocumentMetadata	CDocumentMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_GetMetadataInfo()

CMetadataInfo CDocumentMetadata_GetMetadataInfo	(	const CDocumentMetadata	argCDocumentMetadata,
		idrs_exception *	pargException
	)

Gets the MetadataInfo property value.

Returns

The CMetadataInfo object.

Parameters

argCDocumentMetadata	CDocumentMetadata handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_SetAttachments()

void CDocumentMetadata_SetAttachments	(	CDocumentMetadata	argCDocumentMetadata,
		const CAttachmentArray	argAttachmentArray,
		idrs_exception *	pargException
	)

Sets the array of attachments to add to the output PDF.

Parameters

argCDocumentMetadata	CDocumentMetadata handle
argAttachmentArray	The array of attachments
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

It is not possible to set attachments for PDF/A-1 and PDF/A-2 files, therefore in this case an exception will be thrown.

Calling this method with a NULL parameter will remove any attachments array from this object.

CDocumentMetadata_SetBookmarks()

void CDocumentMetadata_SetBookmarks	(	CDocumentMetadata	argCDocumentMetadata,
		const CPageBookmarkArray	xBookmarks,
		idrs_exception *	pargException
	)

Sets the page's bookmarks.

Parameters

argCDocumentMetadata	CDocumentMetadata handle
xBookmarks	Array of bookmarks
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_SetDigitalSignatures()

void CDocumentMetadata_SetDigitalSignatures	(	CDocumentMetadata	argCDocumentMetadata,
		const CDigitalSignatureArray	xDigitalSignatures,
		idrs_exception *	pargException
	)

Set the digital signatures associated to the ouput pdf document.

Parameters

argCDocumentMetadata	CDocumentMetadata handle
xDigitalSignatures	digital signatures array
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentMetadata_SetMetadataInfo()

void CDocumentMetadata_SetMetadataInfo	(	CDocumentMetadata	argCDocumentMetadata,
		const CMetadataInfo	argMetadataInfo,
		idrs_exception *	pargException
	)

Sets the MetadataInfo property value.

Parameters

argCDocumentMetadata	CDocumentMetadata handle
argMetadataInfo	a CMetadataInfo object.
pargException	Pointer to exception structure that will be filled if an exception occurs