_AWEPlugin Struct Reference

A struct encapsulating the functionality which can be provided by a plugin library. More...

#include <AWEPluginTypes.h>

Data Fields
const char *	apiVersion
	API version that this plugin was built with. More...
const char *	pluginVersion
	Optional plugin version. More...
const char *	name
	Optional plugin name. More...
AWEPluginModuleArray	modules
	List of module classes provided by the plugin.
void(*	cleanup )(const struct _AWEPlugin *)
	Optional destructor. More...

Detailed Description

A struct encapsulating the functionality which can be provided by a plugin library.

This struct is to be returned by the plugin's AWEPlugin_initialize entrypoint. Optional fields can be set to NULL.

Examples

Libtester.c.

Field Documentation

apiVersion

const char* _AWEPlugin::apiVersion

API version that this plugin was built with.

Should always be set to AWE_PLUGIN_API_VERSION

pluginVersion

const char* _AWEPlugin::pluginVersion

Optional plugin version.

If the plugin has its own versioning scheme, use this to present that information to the loader. This is currently unused.

name

const char* _AWEPlugin::name

Optional plugin name.

Currently unused, but should be globally unique.

cleanup

void(* _AWEPlugin::cleanup) (const struct _AWEPlugin *)

Optional destructor.

If set, the loader will call this function before it is freed. Use it to deallocate dynamic memory or any other cleanup task required by the plugin.

---

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

• Source/AWEPlugin/AWEPluginTypes.h