CTextOutputParams_interface.h File Reference

Interface for CTextOutputParams wrapper. More...

Go to the source code of this file.

Functions
CTextOutputParams	CTextOutputParams_Create (enum CharacterEncoding const evCharacterEncoding, idrs_exception *pargException)
	Create is instantiating a new instance of CTextOutputParams and associated data object.
enum CharacterEncoding	CTextOutputParams_GetCharacterEncoding (const CTextOutputParams argCTextOutputParams, idrs_exception *pargException)
	getter for the character encoding.
void	CTextOutputParams_Destroy (CTextOutputParams argCTextOutputParams, idrs_exception *pargException)
	Destroys a CTextOutputParams handle.

Detailed Description

Interface for CTextOutputParams wrapper.

Function Documentation

CTextOutputParams_Create()

CTextOutputParams CTextOutputParams_Create	(	enum CharacterEncoding const	evCharacterEncoding,
		idrs_exception *	pargException
	)

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

Parameters

evCharacterEncoding	character encoding value.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

New instance of CTextOutputParams

Remarks

Instances created by this method can also be provided to COutputParams methods

CTextOutputParams_Destroy()

void CTextOutputParams_Destroy	(	CTextOutputParams	argCTextOutputParams,
		idrs_exception *	pargException
	)

Destroys a CTextOutputParams handle.

Parameters

argCTextOutputParams	CTextOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CTextOutputParams_GetCharacterEncoding()

enum CharacterEncoding CTextOutputParams_GetCharacterEncoding	(	const CTextOutputParams	argCTextOutputParams,
		idrs_exception *	pargException
	)

getter for the character encoding.

Returns

the character encoding type.

Parameters

argCTextOutputParams	CTextOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs