IKpPlugin Struct Reference
Interface to a plugin object.
More...
#include <IKpPlugin.h>
List of all members.
|
Public Member Functions |
| virtual HRESULT | QueryInterface (REFIID riid, void **ppvObject)=0 |
| | COM infrastructure, provides access to all interfaces supported by this object.
|
| virtual ULONG | AddRef ()=0 |
| | COM infrastructure, increments the reference count for this object.
|
| virtual ULONG | Release ()=0 |
| | COM infrastructure, decrements the reference count for this object and eventually deletes it.
|
| virtual BOOL | OnMessage (DWORD dwCode, LPARAM lParamW, LPARAM lParamL)=0 |
| | Plugins are notified of events using this method.
|
| virtual LPCTSTR | GetProperty (LPCTSTR lpName)=0 |
| | Get a plugin property.
|
| virtual HRESULT | SetProperty (LPCTSTR lpName, LPCTSTR lpValue)=0 |
| | Set a plugin property.
|
| virtual DWORD | GetMenuItemCount ()=0 |
| | Get the number of main menu items provided by the plugin.
|
| virtual KP_MENU_ITEM * | GetMenuItems ()=0 |
| | Get a pointer to all main menu items provided by the plugin.
|
Detailed Description
Interface to a plugin object.
Plugins typically provide this interface.
Member Function Documentation
| virtual ULONG IKpPlugin::AddRef |
( |
|
) |
[pure virtual] |
COM infrastructure, increments the reference count for this object.
- Returns:
- Returns the new number of references, only for debugging purposes.
Implements IKpUnknown.
| virtual DWORD IKpPlugin::GetMenuItemCount |
( |
|
) |
[pure virtual] |
Get the number of main menu items provided by the plugin.
| virtual KP_MENU_ITEM* IKpPlugin::GetMenuItems |
( |
|
) |
[pure virtual] |
Get a pointer to all main menu items provided by the plugin.
- Returns:
- Pointer to the first item in an array of menu items.
The menu items must be stored statically, KeePass will not delete the returned pointer.
| virtual LPCTSTR IKpPlugin::GetProperty |
( |
LPCTSTR |
lpName |
) |
[pure virtual] |
Get a plugin property.
- Returns:
- Property value.
If the plugin doesn't know the property with the specified name, it should return NULL.
The returned string must be stored statically, KeePass will not delete the returned pointer.
| virtual BOOL IKpPlugin::OnMessage |
( |
DWORD |
dwCode, |
|
|
LPARAM |
lParamW, |
|
|
LPARAM |
lParamL | |
|
) |
| | [pure virtual] |
Plugins are notified of events using this method.
- Returns:
- In general you should always return TRUE. Only return FALSE if you want to block further code execution in KeePass in some cases.
| virtual HRESULT IKpPlugin::QueryInterface |
( |
REFIID |
riid, |
|
|
void ** |
ppvObject | |
|
) |
| | [pure virtual] |
COM infrastructure, provides access to all interfaces supported by this object.
Implements IKpUnknown.
| virtual ULONG IKpPlugin::Release |
( |
|
) |
[pure virtual] |
COM infrastructure, decrements the reference count for this object and eventually deletes it.
If the number of references reaches zero, the object should delete itself (exception: singletons).
- Returns:
- Returns the new number of references, only for debugging purposes.
Implements IKpUnknown.
| virtual HRESULT IKpPlugin::SetProperty |
( |
LPCTSTR |
lpName, |
|
|
LPCTSTR |
lpValue | |
|
) |
| | [pure virtual] |
Set a plugin property.
This method is allowed to ignore properties it doesn't know (i.e. it doesn't need to implement a generic string dictionary).
The documentation for this struct was generated from the following file: