SourceMM::ISmmPluginManager Class Reference

Programmatic management of the "loaded plugin" list.

#include <IPluginManager.h>

List of all members.

Public Member Functions
virtual PluginId	Load (const char *file, PluginId source, bool &already, char *error, size_t maxlen)=0
	Loads a plugin and returns its id. If this is called before DLLInit(), then the plugin is considered to be "hot" - it might refuse its own load later! Also, a hot plugin might not have an error message.
virtual bool	Unload (PluginId id, bool force, char *error, size_t maxlen)=0
	Unloads a plugin.
virtual bool	Pause (PluginId id, char *error, size_t maxlen)=0
	Pauses a plugin.
virtual bool	Unpause (PluginId id, char *error, size_t maxlen)=0
	Unpauses a plugin.
virtual bool	UnloadAll ()=0
	Unloads all plugins forcefully.
virtual bool	Query (PluginId id, const char **file, Pl_Status *status, PluginId *source)=0
	Returns information about a plugin.
virtual bool	QueryRunning (PluginId id, char *error, size_t maxlength)=0
	Checks another plugin's QueryRunning() status.
virtual bool	QueryHandle (PluginId id, void **handle)=0
	Returns the handle of a plugin (OS dependent meaning).

---

Detailed Description

Definition at line 66 of file IPluginManager.h.

---

Member Function Documentation

virtual PluginId SourceMM::ISmmPluginManager::Load	(	const char *	file,
		PluginId	source,
		bool &	already,
		char *	error,
		size_t	maxlen
	)			[pure virtual]

Parameters:

	file	String containing file name.
	source	Specifies who loaded the plugin.
	already	Whether or not the plugin was already loaded.
	error	String buffer for error messages.
	maxlen	Maximum length of buffer.

Returns:

Id of plugin.

virtual bool SourceMM::ISmmPluginManager::Unload	(	PluginId	id,
		bool	force,
		char *	error,
		size_t	maxlen
	)			[pure virtual]

Parameters:

	id	Id of plugin
	force	True to forcefully unload, false to let plugin opt-out.
	error	String buffer for error messages
	maxlen	Maximum length of buffer

Returns:

True on success, false otherwise

virtual bool SourceMM::ISmmPluginManager::Pause	(	PluginId	id,
		char *	error,
		size_t	maxlen
	)			[pure virtual]

Parameters:

	id	Id of plugin
	error	String buffer for error messages
	maxlen	Maximum length of buffer

Returns:

True on success, false otherwise

virtual bool SourceMM::ISmmPluginManager::Unpause	(	PluginId	id,
		char *	error,
		size_t	maxlen
	)			[pure virtual]

Parameters:

	id	Id of plugin
	error	String buffer for error messages
	maxlen	Maximum length of buffer

Returns:

True on success, false otherwise

virtual bool SourceMM::ISmmPluginManager::UnloadAll

(

)

[pure virtual]

Returns:

True on success, false otherwise

virtual bool SourceMM::ISmmPluginManager::Query	(	PluginId	id,
		const char **	file,
		Pl_Status *	status,
		PluginId *	source
	)			[pure virtual]

Parameters:

	id	Id of plugin
	file	Pointer to store filename pointer, or NULL to ignore.
	status	Pointer to store status, or NULL to ignore.
	source	Pointer to store source, or NULL to ignore.

Returns:

True on success, false if not found

virtual bool SourceMM::ISmmPluginManager::QueryRunning	(	PluginId	id,
		char *	error,
		size_t	maxlength
	)			[pure virtual]

Parameters:

	id	Id of plugin
	error	Message buffer
	maxlength	Size of error buffer

Returns:

Status value

virtual bool SourceMM::ISmmPluginManager::QueryHandle	(	PluginId	id,
		void **	handle
	)			[pure virtual]

Parameters:

	id	Id of plugin
	handle	Pointer to store handle pointer, or NULL to ignore.

Returns:

True if plugin id is valid, false otherwise

---

The documentation for this class was generated from the following file:

• IPluginManager.h