Data Source Plugins

Classes
class	VCDataSource
	Superclass for all data source plugins. More...
Typedefs
typedef ds_dictionary *(*	vc_ds_plugin_description_func )()
typedef void *(*	vc_ds_plugin_factory_func )(void *init_data)
	Function signature for data source factory function "vc_plugin_factory" A factory function with the name vc_plugin_factory and this signature must be provided to construct a new data source.
Functions
void *	VCDataSourceDescription (const char *type, const char *human_name, const char *description, bool requires_config, bool supports_key_value_config)
	Called in the plugin description function to set up the description and provide basic data about the plugin.

---

Typedef Documentation

typedef ds_dictionary*(* vc_ds_plugin_description_func)()

A function with this signature must be implemented by the user. It should return an allocated dictionary that contains descriptive information about the plugin and its required configuration. The function must have the name "vc_plugin_description"

---

Function Documentation

void* VCDataSourceDescription	(	const char *	type,
		const char *	human_name,
		const char *	description,
		bool	requires_config,
		bool	supports_key_value_config
	)

A data source plugin's implementation of vc_plugin_description must call this function to create the data buffer that describes the plugin. The return value from this function should be returned from the vc_plugin_description

Parameters:

type	The type of the plugin; should be in reverse-dns notation (eg, com.psatellite.DSimSource).
human_name	A human readable name that will be presented in user interface elements
description	A description of the plugin, which will be presented to users
requires_config	True if this plugin must always be provided with configuration data, or false if it can operate with default values.
supports_key_value_config	Reserved for future implementation. Present data source plugins should pass false.

Returns:

An opaque pointer to the plugin description. Should be returned to the caller of vc_plugin_description

See also:

vc_ds_plugin_description_func