Portuguese eID Middleware SDK  Version: 3.12.0
eIDMW::PTEID_Config Class Reference

#include <eidlib.h>

Public Member Functions

PTEIDSDK_API PTEID_Config (PTEID_Param Param)
 
PTEIDSDK_API PTEID_Config (const char *csName, const char *czSection, const char *csDefaultValue)
 
PTEIDSDK_API PTEID_Config (const char *csName, const wchar_t *czSection, const wchar_t *csDefaultValue)
 
PTEIDSDK_API PTEID_Config (const char *csName, const char *czSection, long lDefaultValue)
 
virtual PTEIDSDK_API ~PTEID_Config ()
 
PTEIDSDK_API const char * getString ()
 
PTEIDSDK_API long getLong ()
 
PTEIDSDK_API void setString (const char *csValue)
 
PTEIDSDK_API void DeleteKeysByPrefix ()
 
PTEIDSDK_API unsigned int CountKeysByPrefix ()
 
PTEIDSDK_API void setLong (long lValue)
 
- Public Member Functions inherited from eIDMW::PTEID_Object
virtual PTEIDSDK_API ~PTEID_Object ()=0
 
NOEXPORT_PTEIDSDK void Init (const SDK_Context *context, void *impl)
 
NOEXPORT_PTEIDSDK void Release ()
 

Static Public Member Functions

static PTEIDSDK_API void SetTestMode (bool bTestMode)
 

Additional Inherited Members

- Protected Member Functions inherited from eIDMW::PTEID_Object
 PTEID_Object (const SDK_Context *context, void *impl)
 
void addObject (PTEID_Object *impl)
 
void backupObject (unsigned long idx)
 
PTEID_ObjectgetObject (unsigned long idx)
 
PTEID_ObjectgetObject (void *impl)
 
void delObject (unsigned long idx)
 
void delObject (void *impl)
 
void checkContextStillOk () const
 
 PTEID_Object (const PTEID_Object &obj)
 
PTEID_Objectoperator= (const PTEID_Object &obj)
 
- Protected Attributes inherited from eIDMW::PTEID_Object
bool m_delimpl
 
void * m_impl
 
unsigned long m_ulIndexExtAdd
 
std::map< unsigned long, PTEID_Object * > m_objects
 
SDK_Context * m_context
 

Detailed Description

Class to access and modify the config parameters of pteid-mw. These parameters are persisted in the Windows Registry under the HKEY_CURRENT_USER\Software\PTEID key or in the pteid.conf file of the current user (on Linux and MacOS systems)

Constructor & Destructor Documentation

◆ PTEID_Config() [1/4]

PTEIDSDK_API eIDMW::PTEID_Config::PTEID_Config ( PTEID_Param  Param)

Create object to access parameter Param.

◆ PTEID_Config() [2/4]

PTEIDSDK_API eIDMW::PTEID_Config::PTEID_Config ( const char *  csName,
const char *  czSection,
const char *  csDefaultValue 
)

Create object to access a string parameter.

◆ PTEID_Config() [3/4]

PTEIDSDK_API eIDMW::PTEID_Config::PTEID_Config ( const char *  csName,
const wchar_t *  czSection,
const wchar_t *  csDefaultValue 
)

Create object to access a string parameter.

◆ PTEID_Config() [4/4]

PTEIDSDK_API eIDMW::PTEID_Config::PTEID_Config ( const char *  csName,
const char *  czSection,
long  lDefaultValue 
)

Create object to access a numerical parameter.

◆ ~PTEID_Config()

virtual PTEIDSDK_API eIDMW::PTEID_Config::~PTEID_Config ( )
virtual

Destructor

Member Function Documentation

◆ CountKeysByPrefix()

PTEIDSDK_API unsigned int eIDMW::PTEID_Config::CountKeysByPrefix ( )

Count keys with some prefix

◆ DeleteKeysByPrefix()

PTEIDSDK_API void eIDMW::PTEID_Config::DeleteKeysByPrefix ( )

Reset the strings with some prefix (Throw exception for numerical parameter)

◆ getLong()

PTEIDSDK_API long eIDMW::PTEID_Config::getLong ( )

Return the numerical value (Throw exception for string parameter)

◆ getString()

PTEIDSDK_API const char* eIDMW::PTEID_Config::getString ( )

Return the string value (Throw exception for numerical parameter)

◆ setLong()

PTEIDSDK_API void eIDMW::PTEID_Config::setLong ( long  lValue)

Set the numerical value (Throw exception for string parameter)

◆ setString()

PTEIDSDK_API void eIDMW::PTEID_Config::setString ( const char *  csValue)

Set the string value (Throw exception for numerical parameter)

◆ SetTestMode()

static PTEIDSDK_API void eIDMW::PTEID_Config::SetTestMode ( bool  bTestMode)
static

Set the test mode