mv_plugin_details.h File Reference

API function definitions for accessing the plug-in details. More...

#include <mvtec/plugin/mv_decl.h>
#include <mvtec/plugin/mv_types.h>

Functions
MVLibExport MVCode_t	MV_PluginDetails_SetProperty (MVPluginDetails_t details, MVPluginProperty_t property, MVValue_t value)
	Specifies descriptive properties of the plug-in. More...

Detailed Description

API function definitions for accessing the plug-in details.

Function Documentation

MV_PluginDetails_SetProperty()

MVLibExport MVCode_t MV_PluginDetails_SetProperty	(	MVPluginDetails_t	details,
		MVPluginProperty_t	property,
		MVValue_t	value
	)

Specifies descriptive properties of the plug-in.

Depending on the enum value of the property parameter, one of the following properties can be manipulated:

• eMVPluginProperty_Version: The plug-in associated version number. It consists of a major, minor, and patch version. value is an uint32_t array with length 3, where the first element is the major version, the second element is the minor version, and the third element is the patch version.
• eMVPluginProperty_Description: A descriptive message about the plug-in. value is a scalar UTF-8 encoded String.
• eMVPluginProperty_RapidValidation Specifies whether the plug-in supports rapid validation. value is a scalar Bool.

Parameters

[in]	details	is the MVPluginDetails_t where the information is stored.
[in]	property	is the property that is changed.
[in]	value	is an Value containing the value for the specified property. The exact format depends on the property. See the documentation of MVPluginProperty_t for the required format.

Returns

• MV_CODE_OK The provided property has been successfully stored in the plug-in details.
• MV_CODE_INV_HANDLE The provided details argument is not valid.
• MV_CODE_INV_VALUE The value is NULL. Make sure to properly initialize it using MV_Value_Scalar_Init() or MV_Value_Array_Init().
• MV_CODE_FAILED The provided property is unknown.
• MV_CODE_INV_VALUE_TYPE value is passed as an array whereas a scalar is expected, or vice versa. In the case of arrays, the length may be wrong.
• MV_CODE_INV_DATA_TYPE The data type of value does not match the requirement for the selected property.