| class ContentAccess::RStringAttributeSet |
Holds the values of a predefined set of attributes based upon ContentAccess::TStringAttribute
It is also possible for an agent to provide an extended set of these attributes beyond EAgentSpecificAttributeBase but only applications written to support that particular agent will support this.
No duplicate attributes are allowed in the set
| Public Member Functions | |
|---|---|
| RStringAttributeSet() | |
| IMPORT_C void | AddL(TInt) |
| IMPORT_C void | Close() |
| IMPORT_C TInt | Count() |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C TInt | GetValue(TInt, TDes &) |
| IMPORT_C TInt | GetValueLength(TInt) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C TInt | SetValue(TInt, const TDesC &, TInt) |
| IMPORT_C TInt | operator[](TInt) |
| Private Member Functions | |
|---|---|
| void | AddL(TInt, const TDesC &, TInt) |
| Private Attributes | |
|---|---|
| RPointerArray< CStringAttribute > | iAttributes |
| IMPORT_C void | AddL | ( | TInt | aAttribute | ) |
Add a new attribute to the set The attribute value is initalised with an empty string
| TInt aAttribute | The attribute to add to the set |
| void | AddL | ( | TInt | aAttribute, |
| const TDesC & | aValue, | |||
| TInt | aErrorCode | |||
| ) | [private] | |||
| IMPORT_C void | Close | ( | ) |
Release all resources used by the RStringAttributeSet
This must be called before the RStringAttribute set goes out of scope
| IMPORT_C TInt | Count | ( | ) | const |
The number of attributes in the set The number of attributes in the set
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
Write the RAttributeSet to a stream
| RWriteStream & aStream | The stream to write the attribute set to |
| IMPORT_C TInt | GetValue | ( | TInt | aAttribute, |
| TDes & | aValue | |||
| ) | const | |||
Get the value of a specified attribute The value of the attribute
KErrOverflow If the descriptor is not large enough to store the attribute
KErrNotFound if the attribute is not part of the set
| IMPORT_C TInt | GetValueLength | ( | TInt | aAttribute | ) | const |
Get the length of a buffer required to store the value of a specified attribute The length of the value of the attribute
| TInt aAttribute | The attribute to query |
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
Read the RAttributeSet from a stream This does not clear the contents of the attribute set before reading. The values of any attributes already in the set are updated with new values from the stream. New attributes from the stream and their values are added to the set.
| RReadStream & aStream | The stream to read the attribute set from |
| IMPORT_C TInt | SetValue | ( | TInt | aAttribute, |
| const TDesC & | aValue, | |||
| TInt | aErrorCode | |||
| ) | ||||
Set the value of an attribute within the set leave
KErrNotFound if the attribute is not part of the set
| IMPORT_C TInt | operator[] | ( | TInt | aIndex | ) | const |
Find the attribute stored at a particular index in the set The attribute, NOT the value of the attribute
| TInt aIndex | The index of the attribute |