Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::UPN::UpnDbPrefRecord Class Reference
+ Collaboration diagram for SoftwareAndServices::Library::UPN::UpnDbPrefRecord:

Public Member Functions

 UpnDbPrefRecord ()
 UpnDbPrefRecord - Default Constructor. More...
 
virtual ~UpnDbPrefRecord ()
 UpnDbPrefRecord - Destructor. More...
 
bool Save (UpnDbAuthHandle_t AppAuth, UpnDbAuthHandle_t UpnAuth, UpnDB &Handle)
 Save (or update) this preference. More...
 

Static Public Member Functions

static const std::list< UpnDbPrefRecord * > * GetAllPrefs (UpnDbAuthHandle_t AppAuth, UpnDbAuthHandle_t UpnAuth, UpnDbHandleId_t DbHandle)
 Get all preferences for an application, realm, and UPN. More...
 
static const std::list< UpnDbPrefType_t * > * GetPrefTypeList ()
 Get the list of prefs. More...
 
static uint64_t LoadPrefValueTypes (UpnDB &Handle)
 Load the values from the prefs_value_type table. More...
 

Public Attributes

UpnDbApplicationId_t AppId
 The ID of the AppName. More...
 
unsigned int Count
 The number of non NULL entries in Value. More...
 
const char * Key
 The name of the preference. More...
 
UpnDbPrefId_t PrefId
 A unique ID for this preference record. More...
 
UpnDbRealmId_t RealmId
 The realm ID of this record. More...
 
UpnDbUpnId_t UpnId
 The UPN (user) that owns this record. More...
 
UpnDbPrefValueRecord ** Values
 An array of values. More...
 

Static Public Attributes

static std::list< UpnDbPrefRecord * > * _PrefList
 A list of all preferences. More...
 
static std::list< UpnDbPrefType_t * > * _TypeList
 A list of types, cached. More...
 

Detailed Description

Definition at line 311 of file UpnDbPrefRecord.hpp.

Constructor & Destructor Documentation

◆ UpnDbPrefRecord()

SoftwareAndServices::Library::UPN::UpnDbPrefRecord::UpnDbPrefRecord ( )

UpnDbPrefRecord - Default Constructor.

◆ ~UpnDbPrefRecord()

virtual SoftwareAndServices::Library::UPN::UpnDbPrefRecord::~UpnDbPrefRecord ( )
virtual

UpnDbPrefRecord - Destructor.

Member Function Documentation

◆ GetAllPrefs()

static const std::list<UpnDbPrefRecord*>* SoftwareAndServices::Library::UPN::UpnDbPrefRecord::GetAllPrefs ( UpnDbAuthHandle_t  AppAuth,
UpnDbAuthHandle_t  UpnAuth,
UpnDbHandleId_t  DbHandle 
)
static

Get all preferences for an application, realm, and UPN.

Parameters
AppAuthThe UPN authentication handle for the application.
UpnAuthThe UPN authentication handle for the user (UPN's authentication handle).
DbHandleThe UPN database handle.
Returns
A std::list<> of the results.

◆ GetPrefTypeList()

static const std::list<UpnDbPrefType_t*>* SoftwareAndServices::Library::UPN::UpnDbPrefRecord::GetPrefTypeList ( )
static

Get the list of prefs.

Returns
A std::list<UpnDbPrefType_t*> pointer with the prefs.

◆ LoadPrefValueTypes()

static uint64_t SoftwareAndServices::Library::UPN::UpnDbPrefRecord::LoadPrefValueTypes ( UpnDB Handle)
static

Load the values from the prefs_value_type table.

and store them in _TypeList.

Parameters
HandleA UPN DB handle.

◆ Save()

bool SoftwareAndServices::Library::UPN::UpnDbPrefRecord::Save ( UpnDbAuthHandle_t  AppAuth,
UpnDbAuthHandle_t  UpnAuth,
UpnDB Handle 
)

Save (or update) this preference.

Parameters
AppAuthThe UPN authentication handle for the application.
UpnAuthThe UPN authentication handle for the user (UPN's authentication handle).
HandleA UPN DB handle.
Returns
true when saved, false on error.

Member Data Documentation

◆ _PrefList

std::list<UpnDbPrefRecord*>* SoftwareAndServices::Library::UPN::UpnDbPrefRecord::_PrefList
static

A list of all preferences.

Definition at line 384 of file UpnDbPrefRecord.hpp.

◆ _TypeList

std::list<UpnDbPrefType_t*>* SoftwareAndServices::Library::UPN::UpnDbPrefRecord::_TypeList
static

A list of types, cached.

Definition at line 379 of file UpnDbPrefRecord.hpp.

◆ AppId

UpnDbApplicationId_t SoftwareAndServices::Library::UPN::UpnDbPrefRecord::AppId

The ID of the AppName.

Definition at line 404 of file UpnDbPrefRecord.hpp.

◆ Count

unsigned int SoftwareAndServices::Library::UPN::UpnDbPrefRecord::Count

The number of non NULL entries in Value.

Definition at line 419 of file UpnDbPrefRecord.hpp.

◆ Key

const char* SoftwareAndServices::Library::UPN::UpnDbPrefRecord::Key

The name of the preference.

Definition at line 409 of file UpnDbPrefRecord.hpp.

◆ PrefId

UpnDbPrefId_t SoftwareAndServices::Library::UPN::UpnDbPrefRecord::PrefId

A unique ID for this preference record.

Definition at line 389 of file UpnDbPrefRecord.hpp.

◆ RealmId

UpnDbRealmId_t SoftwareAndServices::Library::UPN::UpnDbPrefRecord::RealmId

The realm ID of this record.

Definition at line 394 of file UpnDbPrefRecord.hpp.

◆ UpnId

UpnDbUpnId_t SoftwareAndServices::Library::UPN::UpnDbPrefRecord::UpnId

The UPN (user) that owns this record.

Definition at line 399 of file UpnDbPrefRecord.hpp.

◆ Values

UpnDbPrefValueRecord** SoftwareAndServices::Library::UPN::UpnDbPrefRecord::Values

An array of values.

A NULL terminated list.

Definition at line 414 of file UpnDbPrefRecord.hpp.


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