PtConfigDb Class Reference

#include <PtConfigDb.h>

Public Member Functions
	PtConfigDb ()
virtual	~PtConfigDb ()
PtStatus	loadFromFile (FILE *fp)
PtStatus	storeToFile (FILE *fp)
	retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	remove (const char *pKey)
	retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	set (const char *pKey, const char *pNewValue)
	param: pKey - The key for the key/value pair to be removed retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	get (const char *pKey, char *&rpValue)
	param: pKey - The key for the key/value pair being added (or modified) param: pNewValue - The new value for the key/value pair being added (or modified) retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	get (const char *pKey, int &rValue)
	param: pKey - The lookup key param: rpValue - Set to point to the value corresponding to pKey retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	getNext (const char *pKey, char *&rpNextKey, char *&rpNextValue)
	param: pKey - The lookup key param: rValue - Set to the integer value corresponding to pKey retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	isEmpty (PtBoolean &rIsEmpty)
	param: pKey - The lookup key param: rpNextKey - Set to point to the key for the next key/value pair stored in the database param: rpNextValue - Set to point to the value for the next key/value pair stored in the database retcode: PT_SUCCESS - Success retcode: PT_NO_MORE_DATA - There is no "next" entry retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
PtStatus	numEntries (int &rNumEntries)
	retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

Constructor & Destructor Documentation

PtConfigDb

(

)

~PtConfigDb ( )

virtual

Member Function Documentation

PtStatus get	(	const char *	pKey,
		char *&	rpValue
	)

param: pKey - The key for the key/value pair being added (or modified) param: pNewValue - The new value for the key/value pair being added (or modified) retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus get	(	const char *	pKey,
		int &	rValue
	)

param: pKey - The lookup key param: rpValue - Set to point to the value corresponding to pKey retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getNext	(	const char *	pKey,
		char *&	rpNextKey,
		char *&	rpNextValue
	)

param: pKey - The lookup key param: rValue - Set to the integer value corresponding to pKey retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus isEmpty

(

PtBoolean &

rIsEmpty

)

param: pKey - The lookup key param: rpNextKey - Set to point to the key for the next key/value pair stored in the database param: rpNextValue - Set to point to the value for the next key/value pair stored in the database retcode: PT_SUCCESS - Success retcode: PT_NO_MORE_DATA - There is no "next" entry retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus loadFromFile

(

FILE *

fp

)

PtStatus numEntries

(

int &

rNumEntries

)

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus remove

(

const char *

pKey

)

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus set	(	const char *	pKey,
		const char *	pNewValue
	)

param: pKey - The key for the key/value pair to be removed retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - The key was not found retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus storeToFile

(

FILE *

fp

)

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available