IKpConfig Struct Reference

Interface to a configuration object. More...

#include <IKpConfig.h>

Inheritance diagram for IKpConfig:

List of all members.

Public Member Functions
virtual BOOL	Get (LPCTSTR pszField, LPTSTR pszValue)=0
	Get the string value of a configuration item.
virtual BOOL	Set (LPCTSTR pszField, LPCTSTR pszValue)=0
	Set the string value of a configuration item.
virtual BOOL	GetBool (LPCTSTR pszField, BOOL bDefault)=0
	Get the boolean value of a configuration item.
virtual BOOL	SetBool (LPCTSTR pszField, BOOL bValue)=0
	Set the boolean value of a configuration item.
virtual HRESULT	GetUserPath (LPTSTR lpBuf, DWORD dwBufMaxChars)=0
	Get the KeePass application data path (directory, not INI file), without a terminating separator.

---

Detailed Description

Interface to a configuration object.

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

---

Member Function Documentation

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

Get the string value of a configuration item.

Parameters:

pszValue

This output buffer must be able to hold at least SI_REGSIZE characters (TCHARs).

virtual BOOL IKpConfig::GetBool	(	LPCTSTR	pszField,
		BOOL	bDefault
	)			[pure virtual]

Get the boolean value of a configuration item.

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

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

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.

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:

• IKpConfig.h