This class handles dynamic name-value pair storing. Be warned, all actions are final.

This is how this component works: It has two tables. First one, the column table, contains only single row. This table is actually a header table for the record table. When you set an new attribute, we check that does it already exist in column table. If it does not, it is added as last entry. After that data of the attribute is set to the record table into same column as it is attribute name is in the column table. Row of the settings record is determined by given settingsrecordid.

The column table can hold 0xFFFE (65534) of different user attributes and you can add 0xFF (255) different settingsrecords.

Below is an picture of the tables. Only the ID column is mandatory. All other columns are defined by user.

------------------------------------------------------------ | COLUMNS TABLE | |----------------------------------------------------------- | 1 | 2 | 3 | 4 | 5... | | ------------------------------------------------------------ | ID | SERVER-ADDR | SERVER-PORT | USERNAME | etc...| | ------------------------------------------------------------

------------------------------------------------------------ | RECORDS TABLE | |----------------------------------------------------------- | 1 | 2 | 3 | 4 | 5... | | ------------------------------------------------------------ | 1 | www.gizmo.com | 5223 | Myerdin | etc...| | ------------------------------------------------------------ | 2 | | 5222 | Ballmer | etc...| | ------------------------------------------------------------ | 3 | login.com | | Apple | etc...| | ------------------------------------------------------------ | 4 | aaa.bbb.com | 1234 | user | etc...| | ------------------------------------------------------------

  ---- Example 1 ----------------------------------------------
   Usage example:
   First Create settings record:

   TUint32 settingId(0);
   CXmppSettingsApi* sapi = CXmppSettingsApi::NewLC();
   sapi->CreateSettingsRecordL( settingId );
   CleanupStack::PopAndDestroy( sapi );

   The settingId contains now new id.

 ---- Example 2 ----------------------------------------------
   You can request default settings record (currently returns the first):

   TUint32 settingId(0);
   sapi->DefaultSettingsRecordL( settingId );

   The settingId contains now the id.

  ---- Example 3 ----------------------------------------------
   When you want to add new parameter to the settings record, do following:

   _LIT( KOurParam, "USERNAME");

   sapi->SetParamL( settingId,
                    KOurParam(),
                    aUsername );

   If this is the first time the parameter is added to the settings record,
   it creates new room for it.

  ---- Example 4 ----------------------------------------------
   When you want to get parameter from the settings record, do following:

   _LIT( KOurParam, "USERNAME");
   RBuf value;
   value.CreateL( KMaxParamLength );

   sapi->SetParamL( settingId,
                    KOurParam(),
                    value );

   Value now contains the value recordd in the settings record. If no value
   has been set for this settins records column, then it cannot be
   found ->leaves KErrNotFound.