GetPluginDescription

Description

GetPluginDescription returns information about the plugin. This description appears in the Graphical User Interface (GUI) and in the report.

Syntax

int GetPluginDescription(wchar_t*& owszDescription);

Parameters

Output

owszDescription: Description of the plugin.

Return

(int): returns the identification number of the error if an error occurs or 0 if no error occurs.

Example

To get a full example of the API use, download the .Plugin

#define OPT_PLUGIN_NO_ERROR 0
int GetPluginDescription(wchar_t*& owszDescription)
{
     owszDescription = L"OPTIS - HOA Plugin";
     return OPT_PLUGIN_NO_ERROR;
}