CFormAction_interface.h File Reference

Interface for CFormAction wrapper. More...

Go to the source code of this file.

Functions
CFormAction	CFormAction_Create (enum FormActionType const argFormActionType, idrs_exception *pargException)
	Creates a new form action element of the given type.
enum FormActionType	CFormAction_GetFormActionType (const CFormAction argCFormAction, idrs_exception *pargException)
	GetFormActionType returns the form action type.
CFormActionArray	CFormAction_GetNextFormActions (const CFormAction argCFormAction, idrs_exception *pargException)
	GetNextFormActions returns the array of subsequent form actions.
void	CFormAction_SetNextFormActions (const CFormAction argCFormAction, const CFormActionArray argNextFormActions, idrs_exception *pargException)
	SetNextFormActions sets the array of subsequent form actions.
void	CFormAction_Destroy (CFormAction argCFormAction, idrs_exception *pargException)
	Destroys a CFormAction handle.
CFormActionArray	ArrayInterface_Create_CFormActionArray (idrs_exception *pargException)
	Creates a new CFormActionArray object.

Detailed Description

Interface for CFormAction wrapper.

Function Documentation

ArrayInterface_Create_CFormActionArray()

CFormActionArray ArrayInterface_Create_CFormActionArray

(

idrs_exception *

pargException

)

Creates a new CFormActionArray object.

Parameters

pargException

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

Returns

The newly created CFormActionArray

CFormAction_Create()

CFormAction CFormAction_Create	(	enum FormActionType const	argFormActionType,
		idrs_exception *	pargException
	)

Creates a new form action element of the given type.

Parameters

argFormActionType	Type of the form action to be created
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

New form action instance.

CFormAction_Destroy()

void CFormAction_Destroy	(	CFormAction	argCFormAction,
		idrs_exception *	pargException
	)

Destroys a CFormAction handle.

Parameters

argCFormAction	CFormAction handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormAction_GetFormActionType()

enum FormActionType CFormAction_GetFormActionType	(	const CFormAction	argCFormAction,
		idrs_exception *	pargException
	)

GetFormActionType returns the form action type.

Returns

The FormActionType value

Parameters

argCFormAction	CFormAction handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormAction_GetNextFormActions()

CFormActionArray CFormAction_GetNextFormActions	(	const CFormAction	argCFormAction,
		idrs_exception *	pargException
	)

GetNextFormActions returns the array of subsequent form actions.

Note

The current action is supposed to be executed first by the reader application, then the next actions are executed in a sequence corresponding to their order in the array. Each action in the array may describe subsequent actions, in which case they are also executed in the same way recursively.

Returns

The array containing the next CFormAction objects.

Parameters

argCFormAction	CFormAction handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormAction_SetNextFormActions()

void CFormAction_SetNextFormActions	(	const CFormAction	argCFormAction,
		const CFormActionArray	argNextFormActions,
		idrs_exception *	pargException
	)

SetNextFormActions sets the array of subsequent form actions.

Parameters

argCFormAction	CFormAction handle
argNextFormActions	The array containing the next CFormAction objects.
pargException	Pointer to exception structure that will be filled if an exception occurs