IKpConfig Struct Reference

Interface to a configuration object. More...

#include <IKpConfig.h>

Inheritance diagram for IKpConfig:

Public Member Functions
virtual BOOL	Get (LPCTSTR pszField, LPTSTR pszValue)=0
	Get the string value of a configuration item. More...
virtual BOOL	Set (LPCTSTR pszField, LPCTSTR pszValue)=0
	Set the string value of a configuration item. More...
virtual BOOL	GetBool (LPCTSTR pszField, BOOL bDefault)=0
	Get the boolean value of a configuration item. More...
virtual BOOL	SetBool (LPCTSTR pszField, BOOL bValue)=0
	Set the boolean value of a configuration item. More...
virtual HRESULT	GetUserPath (LPTSTR lpBuf, DWORD dwBufMaxChars)=0
	Get the KeePass application data path (directory, not INI file), without a terminating separator. More...
Public Member Functions inherited from IKpUnknown
virtual HRESULT	QueryInterface (REFIID riid, void **ppvObject)=0
	COM infrastructure, provides access to all interfaces supported by this object. More...
virtual ULONG	AddRef ()=0
	COM infrastructure, increments the reference count for this object. More...
virtual ULONG	Release ()=0
	COM infrastructure, decrements the reference count for this object and eventually deletes it. More...

Detailed Description

Interface to a configuration object.

Instances of classes supporting this interface can be created using IKpAPI::CreateInstance.

Member Function Documentation

Get()

virtual BOOL IKpConfig::Get ( LPCTSTR  pszField, LPTSTR  pszValue  )

pure virtual

Get the string value of a configuration item.

Parameters

pszField	Name of the configuration item.
pszValue	This output buffer must be able to hold at least SI_REGSIZE characters (TCHARs).

GetBool()

virtual BOOL IKpConfig::GetBool ( LPCTSTR  pszField, BOOL  bDefault  )

pure virtual

Get the boolean value of a configuration item.

GetUserPath()

virtual HRESULT IKpConfig::GetUserPath ( LPTSTR  lpBuf, DWORD  dwBufMaxChars  )

pure virtual

Get the KeePass application data path (directory, not INI file), without a terminating separator.

Set()

virtual BOOL IKpConfig::Set ( LPCTSTR  pszField, LPCTSTR  pszValue  )

pure virtual

Set the string value of a configuration item.

Parameters

pszField	Name of the configuration item.
pszValue	New value of the configuration item. If NULL, the configuration item is deleted.

Returns

TRUE, if setting the item has succeeded.

FALSE, otherwise.

SetBool()

virtual BOOL IKpConfig::SetBool ( LPCTSTR  pszField, BOOL  bValue  )

pure virtual

Set the boolean value of a configuration item.

Returns

TRUE, if setting the item has succeeded.

FALSE, otherwise.

---

The documentation for this struct was generated from the following file:

• SDK/Details/IKpConfig.h