PreEmptive Analytics Win32 Client
 All Classes Files Functions Variables Typedefs Macros
Public Member Functions | List of all members
ExtendedKeys Class Reference

Defines a list of name, value pairs to be attached to arbitrary Messages. More...

Public Member Functions

DLL_PACLIENT ExtendedKeys ()
 Create a new set of keys. More...
 
DLL_PACLIENT ~ExtendedKeys ()
 Dispose of a set of keys. More...
 
DLL_PACLIENT void Add (const wchar_t *key, const wchar_t *value)
 Add a string value to the keys. More...
 
DLL_PACLIENT void Add (const wchar_t *key, int value)
 Add a integer value to the keys. More...
 
DLL_PACLIENT void Add (const wchar_t *key, long value)
 Add a long integer value to the keys. More...
 
DLL_PACLIENT void Add (const wchar_t *key, float value)
 Add a floating point value to the keys. More...
 
DLL_PACLIENT void Add (const wchar_t *key, double value)
 Add a double value to the keys. More...
 
DLL_PACLIENT const ExtendedKey * Get (size_t index) const
 Used to iterate though the keys values. More...
 
DLL_PACLIENT size_t Size () const
 Get the number of entries in the key set. More...
 

Detailed Description

Defines a list of name, value pairs to be attached to arbitrary Messages.

Constructor & Destructor Documentation

DLL_PACLIENT ExtendedKeys::ExtendedKeys ( )

Create a new set of keys.

DLL_PACLIENT ExtendedKeys::~ExtendedKeys ( )

Dispose of a set of keys.

Member Function Documentation

DLL_PACLIENT void ExtendedKeys::Add ( const wchar_t *  key,
const wchar_t *  value 
)

Add a string value to the keys.

If a key with the same name already exists in the set it will be replaced.
Parameters
keythe name for the key. If null or blank then nothing will be added.
valuethe value to associated with key
DLL_PACLIENT void ExtendedKeys::Add ( const wchar_t *  key,
int  value 
)

Add a integer value to the keys.

If a key with the same name already exists in the set it will be replaced.
Parameters
keythe name for the key. If null or blank then nothing will be added.
valuethe value to associated with key
DLL_PACLIENT void ExtendedKeys::Add ( const wchar_t *  key,
long  value 
)

Add a long integer value to the keys.

If a key with the same name already exists in the set it will be replaced.
Parameters
keythe name for the key. If null or blank then nothing will be added.
valuethe value to associated with key
DLL_PACLIENT void ExtendedKeys::Add ( const wchar_t *  key,
float  value 
)

Add a floating point value to the keys.

If a key with the same name already exists in the set it will be replaced.
Parameters
keythe name for the key. If null or blank then nothing will be added.
valuethe value to associated with key
DLL_PACLIENT void ExtendedKeys::Add ( const wchar_t *  key,
double  value 
)

Add a double value to the keys.

If a key with the same name already exists in the set it will be replaced.
Parameters
keythe name for the key. If null or blank then nothing will be added.
valuethe value to associated with key
DLL_PACLIENT const ExtendedKey* ExtendedKeys::Get ( size_t  index) const

Used to iterate though the keys values.

Parameters
indexthe zero based index of the key.
Returns
the requested key or null if index is invalid.
DLL_PACLIENT size_t ExtendedKeys::Size ( ) const

Get the number of entries in the key set.

Returns
the number of keys.