Functions operating on Plugin Handles. More...

Functions
char *	tpGetPluginName (TELHandle handle)
	Get the name of a Plugin. More...

char *	tpGetPluginCategory (TELHandle handle)
	Return a plugins Category. A plugin developer may assign this information. More...

char *	tpGetPluginDescription (TELHandle handle)
	Return a plugins description. This is assigned by the plugin developer. More...

char *	tpGetPluginHint (TELHandle handle)
	Return a plugins Hint. This information is assigned by the plugin developer. More...

char *	tpGetPluginInfo (TELHandle handle)
	Return information about a Plugin. More...

char *	tpGetPluginAuthor (TELHandle handle)
	Return plugin author information. More...

char *	tpGetPluginCopyright (TELHandle handle)
	Return plugin copyright information. More...

char *	tpGetPluginVersion (TELHandle handle)
	Return plugin version information. More...

unsigned char *	tpGetPluginManualAsPDF (TELHandle handle)
	Get Plugin manual as PDF. A plugin may embedd a help manual as a PDF. This function return such as a pointer to a string. Use the function getPluginManualNrOfBytes to get the exact length of this string. More...

unsigned int	tpGetPluginManualNrOfBytes (TELHandle handle)
	Get the byte size for the PDF manual. More...

bool	tpAssignRoadRunnerInstance (TELHandle pHandle, TELHandle rrHandle)
	Assign a roadrunner instance handle for the plugin to use. A plugin may use an externally created roadrunner instance for its internal work. More...

bool	tpExecutePlugin (TELHandle handle)
	The executePlugin function is the function designated to fire of a Plugins "worker". What is done when this function is entered is plugin dependent. More...

bool	tpExecutePluginEx (TELHandle handle, bool inAThread)
	The executePluginEx is similar to the executePlugin function, except it takes two extra arguments. More...

char *	tpGetPluginStatus (TELHandle handle)
	Get some status of a plugin. See the plugins documentation on what to expect. More...

char *	tpGetPluginResult (TELHandle handle)
	Returns a plugins result, as a string. See the plugins documentation on what to expect. More...

bool	tpResetPlugin (TELHandle handle)
	Reset a Plugin. Plugin dependent. A reset function should bring the internal state of a plugin to a known state. More...

bool	tpIsPluginWorking (TELHandle handle)
	check if plugin is actively working More...

void	tpTerminateWork (TELHandle handle)
	Terminate any work that is in progress in a plugin. If the plugins worker is executed in a thread, this function will signal the internals of the plugin to terminate. More...

bool	tpIsBeingTerminated (TELHandle handle)
	Check if the work of a plugin is currently being terminated. More...

bool	tpWasTerminated (TELHandle handle)
	wasTerminated. query a plugin if work was terminated before completion More...

bool	tpAssignOnStartedEvent (TELHandle handle, PluginEvent cb, void userData1, void userData2)
	Assign event function fired when a plugin starts its work. More...

bool	tpAssignOnProgressEvent (TELHandle handle, PluginEvent cb, void userData1, void userData2)
	Assign event function fired as a plugin progresses. More...

bool	tpAssignOnFinishedEvent (TELHandle handle, PluginEvent cb, void userData1, void userData2)
	Assign event function fired when a plugin finishes its work. More...

TELHandle	tpGetRoadRunnerHandleFromPlugin (TELHandle handle)
	Get roadrunner instance handle from plugin. More...

char *	tpGetPluginPropertiesAsXML (TELHandle handle)
	Get a Plugins Propertiese as an xml document. The string returned from this function is formated as xml. More...

TELHandle	tpGetPluginProperties (TELHandle handle)
	Get a handle to a plugins properties. More...

char *	tpGetListOfPluginPropertyNames (TELHandle handle)
	Get a list of a plugins property names, as a string. Space being the delimiter. More...

TELHandle	tpGetPluginProperty (TELHandle handle, const char *propertyName)
	Get a handle to a property. More...

TELHandle	tpGetPluginPropertyValueHandle (TELHandle handle, const char *propertyName)
	Get a handle to a property value. More...

char *	tpGetPluginPropertyValueAsString (TELHandle handle, const char *propertyName)
	Get a property value as string. More...

bool	tpSetPluginProperty (TELHandle handle, const char propertyName, const char value)
	Set the value of a PluginProperty by a string. More...

char *	tpGetNamesFromPropertyList (TELHandle handle)
	Get a list of names for a plugins property's. More...

TELHandle	tpGetProperty (TELHandle handle, const char *name)
	Get a handle to a particular property. More...

bool	tpClearPropertyList (TELHandle handle)
	Clear a list of properties. More...

Detailed Description

Functions operating on Plugin Handles.

Function Documentation

bool tpAssignOnFinishedEvent	(	TELHandle	handle,
		PluginEvent	cb,
		void *	userData1,
		void *	userData2
	)

Assign event function fired when a plugin finishes its work.

Parameters

handle	Handle to a plugin
cb	Function pointer to event routine
userData1	void* pointer to user data.
userData2	void* pointer to user data.

Returns: Returns true or false indicating success/failure

bool tpAssignOnProgressEvent	(	TELHandle	handle,
		PluginEvent	cb,
		void *	userData1,
		void *	userData2
	)

Assign event function fired as a plugin progresses.

Parameters

handle	Handle to a plugin
cb	Function pointer to event routine
userData1	void* pointer to user data.
userData2	void* pointer to user data.

Returns: Returns true or false indicating success/failure

bool tpAssignOnStartedEvent	(	TELHandle	handle,
		PluginEvent	cb,
		void *	userData1,
		void *	userData2
	)

Assign event function fired when a plugin starts its work.

Parameters

handle	Handle to a plugin
cb	Function pointer to event routine
userData1	void* pointer to user data.
userData2	void* pointer to user data.

Returns: Returns true or false indicating success/failure

bool tpAssignRoadRunnerInstance	(	TELHandle	pHandle,
		TELHandle	rrHandle
	)

Assign a roadrunner instance handle for the plugin to use. A plugin may use an externally created roadrunner instance for its internal work.

Parameters

pHandle	Handle to a plugin
rrHandle	Handle to a RoadRunner instance

Returns: Returns true or false indicating success/failure

bool tpClearPropertyList ( TELHandle handle)

Clear a list of properties.

Parameters

handle Handle to a Properties list

Returns: Returns true or false indicating result

bool tpExecutePlugin ( TELHandle handle)

The executePlugin function is the function designated to fire of a Plugins "worker". What is done when this function is entered is plugin dependent.

Parameters

handle Handle to a plugin

Returns: Returns true or false indicating success/failure

Note: The execute function is blocking. If the plugin is todo long work, consider using the executePluginEx function that have the option to execute the plugin code in a thread.

bool tpExecutePluginEx	(	TELHandle	handle,
		bool	inAThread
	)

The executePluginEx is similar to the executePlugin function, except it takes two extra arguments.

Parameters

handle	Handle to a plugin
inAThread	bool indicating if the plugin should be executed in a thread.

Returns: Returns true or false indicating success/failure

char* tpGetListOfPluginPropertyNames ( TELHandle handle)

Get a list of a plugins property names, as a string. Space being the delimiter.

Parameters

handle Handle to a plugin

Returns: Returns a string if succesfull, NULL otherwise

char* tpGetNamesFromPropertyList ( TELHandle handle)

Get a list of names for a plugins property's.

Parameters

handle Handle to a plugin

Returns: Returns a string with the names of each property, NULL otherwise

char* tpGetPluginAuthor ( TELHandle handle)

Return plugin author information.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

char* tpGetPluginCategory ( TELHandle handle)

Return a plugins Category. A plugin developer may assign this information.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

char* tpGetPluginCopyright ( TELHandle handle)

Return plugin copyright information.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

char* tpGetPluginDescription ( TELHandle handle)

Return a plugins description. This is assigned by the plugin developer.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

char* tpGetPluginHint ( TELHandle handle)

Return a plugins Hint. This information is assigned by the plugin developer.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

char* tpGetPluginInfo ( TELHandle handle)

Return information about a Plugin.

Parameters

handle Handle to a plugin

Returns: Returns info, as a string, for the plugin, NULL otherwise

unsigned char* tpGetPluginManualAsPDF ( TELHandle handle)

Get Plugin manual as PDF. A plugin may embedd a help manual as a PDF. This function return such as a pointer to a string. Use the function getPluginManualNrOfBytes to get the exact length of this string.

Parameters

handle Handle to a plugin

Returns: Returns the plugins manuals pdf file as a unsigned char*. If not available, returns NULL.

unsigned int tpGetPluginManualNrOfBytes ( TELHandle handle)

Get the byte size for the PDF manual.

Parameters

handle Handle to a plugin

Returns: Returns the nr of bytes in the plugins manuals pdf file as an unsigned int.

char* tpGetPluginName ( TELHandle handle)

Get the name of a Plugin.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

TELHandle tpGetPluginProperties ( TELHandle handle)

Get a handle to a plugins properties.

Parameters

handle Handle to a plugin

Returns: Returns a handle to a plugins property container, NULL otherwise

char* tpGetPluginPropertiesAsXML ( TELHandle handle)

Get a Plugins Propertiese as an xml document. The string returned from this function is formated as xml.

Parameters

handle Handle to a plugin

Returns: Returns available properties in the plugin, as a pointer to a string, NULL otherwise

TELHandle tpGetPluginProperty	(	TELHandle	handle,
		const char *	propertyName
	)

Get a handle to a property.

Parameters

handle	Handle to a plugin
propertyName	Name of the property

Returns: Returns a handle to a property. Returns NULL if not found

char* tpGetPluginPropertyValueAsString	(	TELHandle	handle,
		const char *	propertyName
	)

Get a property value as string.

Parameters

handle	Handle to a plugin
propertyName	Name of the property

Returns: Returns a string (char*) if succesful, returns NULL otherwise.

TELHandle tpGetPluginPropertyValueHandle	(	TELHandle	handle,
		const char *	propertyName
	)

Get a handle to a property value.

Parameters

handle	Handle to a plugin
propertyName	Name of the property

Returns: Returns a handle to the value of a property. Returns NULL if unsuccesful

char* tpGetPluginResult ( TELHandle handle)

Returns a plugins result, as a string. See the plugins documentation on what to expect.

Parameters

handle Handle to a plugin

Returns: Returns a plugins result if available. NULL otherwise

char* tpGetPluginStatus ( TELHandle handle)

Get some status of a plugin. See the plugins documentation on what to expect.

Parameters

handle Handle to a plugin

Returns: Returns plugin status if available, as a string. NULL otherwise

char* tpGetPluginVersion ( TELHandle handle)

Return plugin version information.

Parameters

handle Handle to a plugin

Returns: Returns a string on success, NULL otherwise

TELHandle tpGetProperty	(	TELHandle	handle,
		const char *	name
	)

Get a handle to a particular property.

Parameters

handle	Handle to a property list object
name	Name of the property.

Returns: Returns a handle to a property if successfull, NULL otherwise

TELHandle tpGetRoadRunnerHandleFromPlugin ( TELHandle handle)

Get roadrunner instance handle from plugin.

Parameters

handle Handle to a RoadRunner instance

Returns: Returns a handle if available, returns NULL otherwise

bool tpIsBeingTerminated ( TELHandle handle)

Check if the work of a plugin is currently being terminated.

Parameters

handle Handle to the plugin

Returns: Returns true or false indicating if the work within the plugin is in the process of being terminated

bool tpIsPluginWorking ( TELHandle handle)

check if plugin is actively working

Parameters

handle Handle to a plugin

Returns: Returns true or false indicating i the plugin is busy or not

bool tpResetPlugin ( TELHandle handle)

Reset a Plugin. Plugin dependent. A reset function should bring the internal state of a plugin to a known state.

Parameters

handle Handle to a plugin

Returns: Returns true or false indicating success/failure

bool tpSetPluginProperty	(	TELHandle	handle,
		const char *	propertyName,
		const char *	value
	)

Set the value of a PluginProperty by a string.

Parameters

handle	Handle to a plugin
propertyName	Name of property
value	Value of property, as string

Returns: true if succesful, false otherwise

void tpTerminateWork ( TELHandle handle)

Terminate any work that is in progress in a plugin. If the plugins worker is executed in a thread, this function will signal the internals of the plugin to terminate.

Parameters

handle Handle to a plugin

Returns: Returns true or false indicating success/failure

bool tpWasTerminated ( TELHandle handle)

wasTerminated. query a plugin if work was terminated before completion

Parameters

handle Handle to the plugin

Returns: Returns true or false indicating if the work in the plugin was terminated or not