COutputParams_interface.h File Reference

Interface for COutputParams wrapper. More...

Go to the source code of this file.

Functions
enum OutputFormat	COutputParams_GetOutputFormat (const COutputParams argCOutputParams, idrs_exception *pargException)
	gets the output format.
void	COutputParams_SetIdentifier (COutputParams argCOutputParams, const idrs_string strIdentifier, idrs_exception *pargException)
	Sets a specific identifier to the output params.
const idrs_string	COutputParams_GetIdentifier (const COutputParams argCOutputParams, idrs_exception *pargException)
	Gets the output params identifier.
COutputParamsArray	ArrayInterface_Create_COutputParamsArray (idrs_exception *pargException)
	Creates a new COutputParamsArray object.

Detailed Description

Interface for COutputParams wrapper.

Function Documentation

ArrayInterface_Create_COutputParamsArray()

COutputParamsArray ArrayInterface_Create_COutputParamsArray

(

idrs_exception *

pargException

)

Creates a new COutputParamsArray object.

Parameters

pargException

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

Returns

The newly created COutputParamsArray

COutputParams_GetIdentifier()

const idrs_string COutputParams_GetIdentifier	(	const COutputParams	argCOutputParams,
		idrs_exception *	pargException
	)

Gets the output params identifier.

Returns

The identifier associated with the output params.

Parameters

argCOutputParams	COutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COutputParams_GetOutputFormat()

enum OutputFormat COutputParams_GetOutputFormat	(	const COutputParams	argCOutputParams,
		idrs_exception *	pargException
	)

gets the output format.

Returns

the output format

Parameters

argCOutputParams	COutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COutputParams_SetIdentifier()

void COutputParams_SetIdentifier	(	COutputParams	argCOutputParams,
		const idrs_string	strIdentifier,
		idrs_exception *	pargException
	)

Sets a specific identifier to the output params.

This identifier is used by DocumentOutputProvider to designate for which output a stream is requested when running CDocumentProcessing::ProcessDocument.

By default a unique identifier is generated at COuputParams creation time.

Parameters

argCOutputParams	COutputParams handle
strIdentifier	The user-defined identifier for the output params.
pargException	Pointer to exception structure that will be filled if an exception occurs