CImagePluginManager_interface.h File Reference

Interface for CImagePluginManager wrapper. More...

Go to the source code of this file.

Functions
void	CImagePluginManager_RegisterPlugin (const IBaseImagePlugin argImagePlugin, idrs_exception *pargException)
	RegisterPlugin adds a plugin to the plugin list.
IDRS_UINT32	CImagePluginManager_GetPluginCount (idrs_exception *pargException)
	Returns the number of plugins already added to image plugin registry.
IBaseImagePlugin	CImagePluginManager_GetAt (IDRS_UINT32 const uiIndex, idrs_exception *pargException)
	GetAt returns a reference to a plugin already added.
void	CImagePluginManager_RemoveAt (IDRS_UINT32 const uiIndex, idrs_exception *pargException)
	RemoveAt removes a plugin at a specified index.
void	CImagePluginManager_RemoveAll (idrs_exception *pargException)
	RemoveAll clears the internal container of any previous added plugin.
IBaseImagePlugin	CImagePluginManager_GetDefaultPlugin (idrs_exception *pargException)
	GetDefaultPlugin returns the default imaging plugin.
void	CImagePluginManager_Unload (idrs_exception *pargException)
	Unloads all plugin objects that are loaded.

Detailed Description

Interface for CImagePluginManager wrapper.

Function Documentation

CImagePluginManager_GetAt()

IBaseImagePlugin CImagePluginManager_GetAt	(	IDRS_UINT32 const	uiIndex,
		idrs_exception *	pargException
	)

GetAt returns a reference to a plugin already added.

Parameters

uiIndex	Index of the plugin to be returned
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

Reference to the plugin stored at specified index

CImagePluginManager_GetDefaultPlugin()

IBaseImagePlugin CImagePluginManager_GetDefaultPlugin

(

idrs_exception *

pargException

)

GetDefaultPlugin returns the default imaging plugin.

Returns

The default imaging plugin

Parameters

pargException

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

CImagePluginManager_GetPluginCount()

IDRS_UINT32 CImagePluginManager_GetPluginCount

(

idrs_exception *

pargException

)

Returns the number of plugins already added to image plugin registry.

Returns

The number of plugins already added

Parameters

pargException

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

CImagePluginManager_RegisterPlugin()

void CImagePluginManager_RegisterPlugin	(	const IBaseImagePlugin	argImagePlugin,
		idrs_exception *	pargException
	)

RegisterPlugin adds a plugin to the plugin list.

Please note that the plugin is added by reference. iDRS SDK will store the reference internally. It is integrator's job to make sure that the reference is still valid during the program execution or until the plugin is removed from CImagePluginManager

Parameters

argImagePlugin	Reference to the plugin to be added
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginManager_RemoveAll()

void CImagePluginManager_RemoveAll

(

idrs_exception *

pargException

)

RemoveAll clears the internal container of any previous added plugin.

Please note that iDRS SDK will not try to perform delete or cleanup of the removed objects. It is integrator's job to cleanup any memory used by the plugins.

Parameters

pargException

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

CImagePluginManager_RemoveAt()

void CImagePluginManager_RemoveAt	(	IDRS_UINT32 const	uiIndex,
		idrs_exception *	pargException
	)

RemoveAt removes a plugin at a specified index.

Please note that iDRS SDK will not try to perform delete or cleanup of the removed object. It is integrator's job to cleanup any memory used by the plugin.

Parameters

uiIndex	Index where to remove
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginManager_Unload()

void CImagePluginManager_Unload

(

idrs_exception *

pargException

)

Unloads all plugin objects that are loaded.

Parameters

pargException

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