CAttachment_interface.h File Reference

Interface for CAttachment wrapper. More...

Go to the source code of this file.

Functions
CAttachment	CAttachment_Create (const idrs_string strAttachFileName, enum AttachmentType const evAttachmentType, const idrs_string strFilePath, IDRS_BOOL const bCopyContent, idrs_exception *pargException)
	Create a CAttachment object from a file path.
CAttachment	CAttachment_Create2 (const idrs_string strAttachFileName, enum AttachmentType const evAttachmentType, const idrs_string strFilePath, idrs_exception *pargException)
	Create a CAttachment object from a file path.
CAttachment	CAttachment_Create3 (const idrs_string strAttachFileName, enum AttachmentType const evAttachmentType, IByteStream argStream, IDRS_BOOL const bCopyContent, idrs_exception *pargException)
	Create a CAttachment object from a stream.
CAttachment	CAttachment_Create4 (const idrs_string strAttachFileName, enum AttachmentType const evAttachmentType, IByteStream argStream, idrs_exception *pargException)
	Create a CAttachment object from a stream.
void	CAttachment_Destroy (CAttachment argCAttachment, idrs_exception *pargException)
	Destroys a CAttachment handle.
CAttachmentArray	ArrayInterface_Create_CAttachmentArray (idrs_exception *pargException)
	Creates a new CAttachmentArray object.

Detailed Description

Interface for CAttachment wrapper.

Function Documentation

ArrayInterface_Create_CAttachmentArray()

CAttachmentArray ArrayInterface_Create_CAttachmentArray

(

idrs_exception *

pargException

)

Creates a new CAttachmentArray object.

Parameters

pargException

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

Returns

The newly created CAttachmentArray

CAttachment_Create()

CAttachment CAttachment_Create	(	const idrs_string	strAttachFileName,
		enum AttachmentType const	evAttachmentType,
		const idrs_string	strFilePath,
		IDRS_BOOL const	bCopyContent,
		idrs_exception *	pargException
	)

Create a CAttachment object from a file path.

Parameters

strAttachFileName	The name of the file to attach, as it will appear in the output PDF. A period should be used to separate the base file name from the file extension.
evAttachmentType	The type of the attachment
strFilePath	Path to the file to attach
bCopyContent	If true, the file's content will be copied at object's creation; otherwise it will be
pargException	Pointer to exception structure that will be filled if an exception occurs read only during the call to CDocumentWriter::Save().

CAttachment_Create2()

CAttachment CAttachment_Create2	(	const idrs_string	strAttachFileName,
		enum AttachmentType const	evAttachmentType,
		const idrs_string	strFilePath,
		idrs_exception *	pargException
	)

Create a CAttachment object from a file path.

Parameters

strAttachFileName	The name of the file to attach, as it will appear in the output PDF. A period should be used to separate the base file name from the file extension.
evAttachmentType	The type of the attachment
strFilePath	Path to the file to attach
pargException	Pointer to exception structure that will be filled if an exception occurs read only during the call to CDocumentWriter::Save().

CAttachment_Create3()

CAttachment CAttachment_Create3	(	const idrs_string	strAttachFileName,
		enum AttachmentType const	evAttachmentType,
		IByteStream	argStream,
		IDRS_BOOL const	bCopyContent,
		idrs_exception *	pargException
	)

Create a CAttachment object from a stream.

Parameters

strAttachFileName	The name of the file to attach, as it will appear in the output PDF. A period should be used to separate the base file name from the file extension.
evAttachmentType	The type of the attachment
argStream	The content of the file to attach
bCopyContent	If true, the stream's content will be copied at object's creation; otherwise it will be
pargException	Pointer to exception structure that will be filled if an exception occurs read only during the call to CDocumentWriter::Save().

CAttachment_Create4()

CAttachment CAttachment_Create4	(	const idrs_string	strAttachFileName,
		enum AttachmentType const	evAttachmentType,
		IByteStream	argStream,
		idrs_exception *	pargException
	)

Create a CAttachment object from a stream.

Parameters

strAttachFileName	The name of the file to attach, as it will appear in the output PDF. A period should be used to separate the base file name from the file extension.
evAttachmentType	The type of the attachment
argStream	The content of the file to attach
pargException	Pointer to exception structure that will be filled if an exception occurs read only during the call to CDocumentWriter::Save().

CAttachment_Destroy()

void CAttachment_Destroy	(	CAttachment	argCAttachment,
		idrs_exception *	pargException
	)

Destroys a CAttachment handle.

Parameters

argCAttachment	CAttachment handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs