Loading and Unloading the Plugin, General Functionality
Enumerations | |
enum | CryptPlugWrapper::InitStatus { InitStatus_undef = 0, InitStatus_Ok = 1, InitStatus_NoLibName = 2, InitStatus_LoadError = 0x1000, InitStatus_InitError = 0x2000 } |
Functions | |
const char * | CryptPlug::libVersion (void) |
const char * | CryptPlug::bugURL (void) |
int | CryptPlug::interfaceVersion (int *min_version) |
bool | CryptPlug::initialize (void) |
bool | CryptPlug::hasFeature (Feature) |
void | CryptPlugWrapper::deinitialize () |
InitStatus | CryptPlugWrapper::initStatus (QString *errorMsg) const |
bool | CryptPlugWrapper::hasFeature (Feature) |
const char * | CryptPlugWrapper::bugURL () |
Detailed Description
The functions in this section are used for loading and unloading plugins. Note that the actual locating of the plugin and the loading and unloading of the dynamic library is not covered here; this is MUA-specific code for which support code might already exist in the programming environments.Enumeration Type Documentation
|
Current initialization state.
This flag holding status of previous call of initialize function. If initialize was not called before return value will be
Referenced by CryptPlugWrapper::initStatus(). |
Function Documentation
|
This function returns the version string of this cryptography plug-in. If the plugins initialization fails the calling process might want to display the library version number to the user for checking if there is an old version of the library installed...
|
|
This function returns a URL to be used for reporting a bug that you found (or suspect, resp.) in this cryptography plug-in. If the plugins for some reason cannot specify an appropriate URL you should at least be provided with a text giving you some advise on how to report a bug.
|
|
Return the current interface version of the plugin. Return the current interface version. This is a simple way for a user to check whether all required fucntions are available. If MIN_VERSION is not NULL the lowest supported version of the interface is returned in addition. The version is a positive integer. A user should check for the existance of this function before using it; if the fucntion does not exist, a interface version of 0 should be assumed. This function may be called prior to initialize(). Definition at line 323 of file cryptplug.cpp. |
|
This function sets up all internal structures.
Plugins that need no initialization should provide an empty implementation. The method returns
|
|
This function frees all internal structures. This function returns Not all plugins will support all features; a complete Sphinx implementation will support all features contained in the enum, however.
|
|
This function unloads the lib and frees all internal structures. After this function has been called, no other plugin functions should be called; the behavior is undefined in this case.
Referenced by CryptPlugWrapper::~CryptPlugWrapper(). |
|
Returns this CRYPTPLUG wrapper's initialization state.
References CryptPlugWrapper::InitStatus. |
|
This function returns Not all plugins will support all features; a complete Sphinx implementation will support all features contained in the enum, however.
|
|
This function returns a URL to be used for reporting a bug that you found (or suspect, resp.) in this cryptography plug-in. If the plugins for some reason cannot specify an appropriate URL you should at least be provided with a text giving you some advise on how to report a bug.
|