Enumerations | |
| enum | CryptPlugWrapper::IniStatus { IniStatus_undef = 0 , IniStatus_Ok = 1 , IniStatus_NoLibName = 2 , IniStatus_LoadError = 0x1000 , IniStatus_InitError = 0x2000 } |
Functions | |
| bool | CryptPlug::initialize (void) |
| bool | CryptPlug::hasFeature (::Feature) |
| void | CryptPlugWrapper::deinitialize () |
| IniStatus | CryptPlugWrapper::iniStatus (TQString *errorMsg) const |
| bool | CryptPlugWrapper::hasFeature (::Feature) |
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.
The functions in this section are used for loading and unloading the respective CRYPTPLUG library, for (re)setting it's internal data structures and for retrieving information on the implementation state of all functions covered by the CRYPTPLUG API.
Enumeration Type Documentation
◆ IniStatus
Current initialization state.
This flag holding status of previous call of initialize function. If initialize was not called before return value will be CryptPlugInit_undef.
- See also
- iniStatus, initialize
Definition at line 467 of file cryptplugwrapper.h.
Function Documentation
◆ deinitialize()
| void CryptPlugWrapper::deinitialize | ( | ) |
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.
\note Deinitializing sets the internal iniStatus value back
to \c IniStatus_undef.
\sa iniStatus, initialize, CryptPlugWrapper, ~CryptPlugWrapper
\sa setActive, active
Definition at line 542 of file cryptplugwrapper.cpp.
◆ hasFeature() [1/2]
| bool CryptPlug::hasFeature | ( | ::Feature | ) |
This function frees all internal structures.
Plugins that do not keep any internal structures should provide an empty implementation. After this function has been called, no other plugin functions should be called; the behavior is undefined in this case.
- Note
- This function must be implemented by each plug-in using this API specification.
This function returns true if the specified feature is available in the plugin, and false otherwise.
Not all plugins will support all features; a complete Sphinx implementation will support all features contained in the enum, however.
- Note
- This function must be implemented by each plug-in using this API specification.
Definition at line 279 of file cryptplug.cpp.
◆ hasFeature() [2/2]
| bool CryptPlugWrapper::hasFeature | ( | ::Feature | ) |
This function returns true if the specified feature is available in the plugin, and false otherwise.
Not all plugins will support all features; a complete Sphinx implementation will support all features contained in the enum, however.
- Note
- In case this function cannot be executed the system's error message may be retrieved by calling iniStatus( TQString* ).
- Returns
- whether the relative feature is implemented or not
Definition at line 558 of file cryptplugwrapper.cpp.
◆ iniStatus()
| CryptPlugWrapper::IniStatus CryptPlugWrapper::iniStatus | ( | TQString * | errorMsg | ) | const |
Returns this CRYPTPLUG wrapper's initialization state.
- Parameters
-
errorMsg receives the last system error message, this value should be ignored if IniStatus value equals IniStatus_Ok.
- Returns
- whether the relative library was loaded and initialized correctly
- See also
- initialize, deinitialize, CryptPlugWrapper(), ~CryptPlugWrapper
- setActive, active
Definition at line 550 of file cryptplugwrapper.cpp.
◆ initialize()
| bool CryptPlug::initialize | ( | void | ) |
This function sets up all internal structures.
Plugins that need no initialization should provide an empty implementation. The method returns true if the initialization was successful and false otherwise. Before this function is called, no other plugin functions should be called; the behavior is undefined in this case.
- Note
- This function must be implemented by each plug-in using this API specification.
Definition at line 272 of file cryptplug.cpp.