mv_plugin_details_def.h File Reference

Type definitions for plug-in details. More...

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

Enumerations
enum	MVPluginProperty_t {   eMVPluginProperty_Version = 0,   eMVPluginProperty_Description = 1,   eMVPluginProperty_RapidValidation = 2 }
	These properties describe details about the plug-in. More...

Detailed Description

Type definitions for plug-in details.

Typedef Documentation

MVPluginDetails_t

typedef struct _MVPluginDetails_t* MVPluginDetails_t

Opaque data type which stores additional details about the plug-in.

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

Enumeration Type Documentation

MVPluginProperty_t

enum MVPluginProperty_t

These properties describe details about the plug-in.

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 plug-in version. A plug-in version a three-element UInt32 array, consisting of a major, minor, and patch version. It may be shown along the plug-in name.
eMVPluginProperty_Description	Specifies a descriptive text for the plug-in. This UTF-8 encoded string may describe the plug-in.
eMVPluginProperty_RapidValidation	Specifies whether the plug-in supports rapid validation. A Boolean hint for the plug-in configuration GUI whether the plug-in's validation logic is relatively lightweight. The plug-in 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. Plug-ins which only perform internal consistency checks may set this property to true to opt into the rapid validation feature whereas plug-ins 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.