#include <es_sock.h>
| class RSubConParameterBundle |
| Public Member Functions | |
|---|---|
| RSubConParameterBundle() | |
| IMPORT_C void | AddFamilyL(CSubConParameterFamily *) |
| IMPORT_C void | ClearAllParameters(CSubConParameterFamily::TParameterSetType) |
| IMPORT_C void | Close() |
| void | CopyFromFamilyBundleL(RParameterFamilyBundle &) |
| void | CopyToFamilyBundleL(RParameterFamilyBundle &) |
| IMPORT_C CSubConParameterFamily * | FindFamily(TUint32) |
| IMPORT_C TUint | Length() |
| IMPORT_C TInt | Load(const TDesC8 &) |
| IMPORT_C TInt | Store(TDes8 &) |
| Protected Member Functions | |
|---|---|
| TInt | CheckBundle() |
Container for (bundle of) SubConnection parameter families.
May contain and 0..N SubConnection parameter families.
Note: If the RSubConParameterBundle object takes ownership of any CSubConParameterFamily object, then when the bundle object is destroyed, any family owned by this object will also be destroyed.
THIS API IS DEPRECATED IN FAVOUR OF RParameterFamilyBundle
Deprecatedsince v9.6
| IMPORT_C | RSubConParameterBundle | ( | ) |
Empty sub-connection parameter bundle constructor
| IMPORT_C void | AddFamilyL | ( | CSubConParameterFamily * | aFamily | ) |
Add a sub-connection parameter family to the bundle.
Note: The RSubConParameterBundle object takes ownership of the parameter family that is passed into this method. When the bundle object is destroyed, any family owned by this object will also be destroyed.
| leaves |
with KErrNoMemory in out of memory conditions |
| Parameter | Description |
|---|---|
| aFamily | Family to be added (bundle takes ownership) |
| TInt | CheckBundle | ( | ) | const [protected] |
Check to see if the handle has a heap object. If it hasn't, it creates one
Returns: KErrNone if successful, otherwise a system wide error
| IMPORT_C void | ClearAllParameters | ( | CSubConParameterFamily::TParameterSetType | aType | ) |
Clears (removes and deletes) all parameter sets with the type specified (delegated to the families)
| Parameter | Description |
|---|---|
| aType | The type of the set to be deleted(requested, acceptable or granted) |
| void | CopyFromFamilyBundleL | ( | RParameterFamilyBundle & | aSrc | ) |
Copy the contents of an RParameterFamilyBundle to this RSubConParameterBundle
| Parameter | Description |
|---|---|
| aSrc | RParameterFamilyBundle to copy contents from |
| void | CopyToFamilyBundleL | ( | RParameterFamilyBundle & | aDest | ) | const |
Copy the contents of this parameter bundle to a RParameterFamilyBundle.
| Parameter | Description |
|---|---|
| aDest | RParameterFamilyBundle to copy parameters to |
| IMPORT_C CSubConParameterFamily * | FindFamily | ( | TUint32 | aFamilyId | ) |
Search the sub-connection parameter bundle for a parameter family
| Parameter | Description |
|---|---|
| aFamilyId | Id of the family to match against. It is an identifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined. |
Returns: Matching family or NULL pointer if not found
| IMPORT_C TUint | Length | ( | ) | const |
Calculates the length of buffer required to serialise this parameter set bundle.
Returns: Length of buffer required.
Instructs this sub-connection parameter bundle to create a serilised version of itself and append it to the buffer that has been passed.
| Parameter | Description |
|---|---|
| aDes | Buffer to append the serialised object to |
Returns: KErrNone if successful, otherwise system wide error (e.g. EKrrOverflow if the descriptor is too small) If unsuccessful, there is no guarantee as to the buffer or data stored in it.