mv_plugin_details_def.h File Reference

Type definitions for plugin details. More...

Typedefs
typedef enum MVPluginProperty_t	MVPluginProperty_t
typedef struct _MVPluginDetails_t *	MVPluginDetails_t
	Opaque data type which stores additional details about the plugin. More...

Enumerations
enum	MVPluginProperty_t {   eMVPluginProperty_Version = 0 ,   eMVPluginProperty_Description = 1 ,   eMVPluginProperty_RapidValidation = 2 ,   eMVPluginProperty_Force32 = 0x7FFFFFFF }
	These properties describe details about the plugin. More...

Detailed Description

Type definitions for plugin details.

Typedef Documentation

MVPluginDetails_t

typedef struct _MVPluginDetails_t* MVPluginDetails_t

Opaque data type which stores additional details about the plugin.

MVPluginDetails_t is a pointer to an opaque data structure. It is passed as an argument to the optional MVDetails plugin function, where it can be filled with additional plugin details using the API functions in mv_plugin_details.h.

Enumeration Type Documentation

MVPluginProperty_t

enum MVPluginProperty_t

These properties describe details about the plugin.

Set these properties by calling MV_PluginDetails_SetProperty(), passing the enum value and an MVValue_t with the data structured as documented.

Enumerator
eMVPluginProperty_Version	Specifies the plugin version. A plugin version a three-element UInt32 array, consisting of a major, minor, and patch version. It may be shown along the plugin name.
eMVPluginProperty_Description	Specifies a descriptive text for the plugin. This UTF-8 encoded string may describe the plugin.
eMVPluginProperty_RapidValidation	Specifies whether the plugin supports rapid validation. A Boolean hint for the plugin configuration GUI whether the plugin's validation logic is relatively lightweight. The plugin configuration GUI may take this hint to run the validation more frequently, e.g., upon individual keystrokes in the configuration GUI, as to provide the user with a more interactive experience. Plugins which only perform internal consistency checks may set this property to true to opt into the rapid validation feature whereas plugins performing more expensive actions like calling into third-party libraries, e.g., to gather information on connected hardware or network devices, should refrain from doing so.