CDocumentSeparationOptions_interface.h File Reference

Interface for CDocumentSeparationOptions wrapper. More...

Go to the source code of this file.

Functions
CDocumentSeparationOptions	CDocumentSeparationOptions_Create (idrs_exception *pargException)
	Create is instantiating a new instance of CDocumentSeparationOptions and associated data object.
void	CDocumentSeparationOptions_SetMaxDocumentSize (CDocumentSeparationOptions argCDocumentSeparationOptions, IDRS_UINT64 const uiMaxDocumentSize, idrs_exception *pargException)
	Sets the MaxDocumentSize property, which defines the size threshold for the created document(s).
IDRS_UINT64	CDocumentSeparationOptions_GetMaxDocumentSize (const CDocumentSeparationOptions argCDocumentSeparationOptions, idrs_exception *pargException)
	Gets the MaxDocumentSize property value.
void	CDocumentSeparationOptions_SetDocumentSeparationCallback (CDocumentSeparationOptions argCDocumentSeparationOptions, IDocumentSeparationCallback argpDocumentSeparationCallback, idrs_exception *pargException)
	Sets the document separation callback which allows using an integrator defined custom function.
IDocumentSeparationCallback	CDocumentSeparationOptions_GetDocumentSeparationCallback (const CDocumentSeparationOptions argCDocumentSeparationOptions, idrs_exception *pargException)
	GetOutputProgressCallback gets the document separation callback property.
void	CDocumentSeparationOptions_Destroy (CDocumentSeparationOptions argCDocumentSeparationOptions, idrs_exception *pargException)
	Destroys a CDocumentSeparationOptions handle.

Detailed Description

Interface for CDocumentSeparationOptions wrapper.

Function Documentation

CDocumentSeparationOptions_Create()

CDocumentSeparationOptions CDocumentSeparationOptions_Create

(

idrs_exception *

pargException

)

Create is instantiating a new instance of CDocumentSeparationOptions and associated data object.

The separation properties are initially unset, therefore the document separation will be disabled by default.

Returns

New instance of CDocumentSeparationOptions

Parameters

pargException

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

CDocumentSeparationOptions_Destroy()

void CDocumentSeparationOptions_Destroy	(	CDocumentSeparationOptions	argCDocumentSeparationOptions,
		idrs_exception *	pargException
	)

Destroys a CDocumentSeparationOptions handle.

Parameters

argCDocumentSeparationOptions	CDocumentSeparationOptions handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentSeparationOptions_GetDocumentSeparationCallback()

IDocumentSeparationCallback CDocumentSeparationOptions_GetDocumentSeparationCallback	(	const CDocumentSeparationOptions	argCDocumentSeparationOptions,
		idrs_exception *	pargException
	)

GetOutputProgressCallback gets the document separation callback property.

Returns

The callback pointer

Parameters

argCDocumentSeparationOptions	CDocumentSeparationOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentSeparationOptions_GetMaxDocumentSize()

IDRS_UINT64 CDocumentSeparationOptions_GetMaxDocumentSize	(	const CDocumentSeparationOptions	argCDocumentSeparationOptions,
		idrs_exception *	pargException
	)

Gets the MaxDocumentSize property value.

Returns

The threshold value for document size (in bytes)

Parameters

argCDocumentSeparationOptions	CDocumentSeparationOptions handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocumentSeparationOptions_SetDocumentSeparationCallback()

void CDocumentSeparationOptions_SetDocumentSeparationCallback	(	CDocumentSeparationOptions	argCDocumentSeparationOptions,
		IDocumentSeparationCallback	argpDocumentSeparationCallback,
		idrs_exception *	pargException
	)

Sets the document separation callback which allows using an integrator defined custom function.

See

See also

IDocumentSeparationCallback class for more details about expected custom callback method.

Parameters

argCDocumentSeparationOptions	CDocumentSeparationOptions handle
argpDocumentSeparationCallback	Integrator custom callback object that decides whether iDRS SDK should trigger a document separation or not.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

This property and the MaxDocumentSize are both mutually exclusive; assigning a value to one of them will reset the other.

CDocumentSeparationOptions_SetMaxDocumentSize()

void CDocumentSeparationOptions_SetMaxDocumentSize	(	CDocumentSeparationOptions	argCDocumentSeparationOptions,
		IDRS_UINT64 const	uiMaxDocumentSize,
		idrs_exception *	pargException
	)

Sets the MaxDocumentSize property, which defines the size threshold for the created document(s).

Any document created with iDRS SDK is expected to have the size in bytes lower than the threshold value of this property.

Setting 0 as the threshold value will disable the separation of documents by size

Parameters

argCDocumentSeparationOptions	CDocumentSeparationOptions handle
uiMaxDocumentSize	Threshold value for the document size (in bytes)
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

This property and the MaxDocumentSize are both mutually exclusive; assigning a value to one of them will reset the other.