| class TDesC8 |
Abstract base class for 8-bit non-modifiable descriptors.
The class encapsulates the data member containing the length of data represented by an 8-bit descriptor. It also provides member functions through which the data can be accessed, but not modified.
Data represented by this class is treated as a contiguous set of 8-bit (i.e. single byte) values or data items.
This class cannot be instantiated as it is intended to form part of a class hierarchy; it provides a well defined part of descriptor behaviour. It can, however, be passed as an argument type for functions which want access to descriptor data but do not need to modify that data.
| Public Member Functions | |
|---|---|
| IMPORT_C HBufC8 * | Alloc () |
| IMPORT_C HBufC8 * | AllocL () |
| IMPORT_C HBufC8 * | AllocLC () |
| IMPORT_C TInt | Compare (const TDesC8 &) |
| IMPORT_C TInt | CompareC (const TDesC8 &) |
| IMPORT_C TInt | CompareF (const TDesC8 &) |
| IMPORT_C TInt | Find (const TDesC8 &) |
| IMPORT_C TInt | Find (const TUint8 *, TInt ) |
| IMPORT_C TInt | FindC (const TDesC8 &) |
| IMPORT_C TInt | FindC (const TUint8 *, TInt ) |
| IMPORT_C TInt | FindF (const TDesC8 &) |
| IMPORT_C TInt | FindF (const TUint8 *, TInt ) |
| IMPORT_C TPtrC8 | Left ( TInt ) |
| TInt | Length () |
| IMPORT_C TInt | Locate ( TChar ) |
| IMPORT_C TInt | LocateF ( TChar ) |
| IMPORT_C TInt | LocateReverse ( TChar ) |
| IMPORT_C TInt | LocateReverseF ( TChar ) |
| IMPORT_C TInt | Match (const TDesC8 &) |
| IMPORT_C TInt | MatchC (const TDesC8 &) |
| IMPORT_C TInt | MatchF (const TDesC8 &) |
| IMPORT_C TPtrC8 | Mid ( TInt ) |
| IMPORT_C TPtrC8 | Mid ( TInt , TInt ) |
| IMPORT_C const TUint8 * | Ptr () |
| IMPORT_C TPtrC8 | Right ( TInt ) |
| TInt | Size () |
| TBool | operator!= (const TDesC8 &) |
| TBool | operator< (const TDesC8 &) |
| TBool | operator<= (const TDesC8 &) |
| TBool | operator== (const TDesC8 &) |
| TBool | operator> (const TDesC8 &) |
| TBool | operator>= (const TDesC8 &) |
| const TUint8 & | operator[] ( TInt ) |
| Protected Member Functions | |
|---|---|
| TDesC8 ( TInt , TInt ) | |
| TDesC8 () | |
| IMPORT_C const TUint8 & | AtC ( TInt ) |
| void | DoSetLength ( TInt ) |
| TInt | Type () |
| Private Attributes | |
|---|---|
| __DECLARE_TEST | |
| TUint | iLength |
| IMPORT_C HBufC8 * | Alloc | ( | ) | const |
Creates a new 8-bit heap descriptor and initialises it with a copy of this descriptor's data.
| IMPORT_C HBufC8 * | AllocL | ( | ) | const |
Creates a new 8-bit heap descriptor and initialises it with a copy of this descriptor's data.
The function leaves, if creation of the descriptor fails.
| IMPORT_C HBufC8 * | AllocLC | ( | ) | const |
Creates a new 8-bit heap descriptor, initialises it with a copy of this descriptor's data, and puts a pointer to the descriptor onto the cleanup stack.
The function leaves, if creation of the descriptor fails.
| IMPORT_C TInt | Compare | ( | const TDesC8 & | aDes | ) | const |
Compares this descriptor's data with the specified descriptor's data.
The comparison proceeds on a byte for byte basis. The result of the comparison is based on the difference of the first bytes to disagree.
Two descriptors are equal if they have the same length and content. Where two descriptors have different lengths and the shorter descriptor's data matches the first part of the longer descriptor's data, the shorter is considered to be less than the longer.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| IMPORT_C TInt | CompareC | ( | const TDesC8 & | aDes | ) | const |
Compares this descriptor's data with the specified descriptor's data using the standard collation method for narrow text appropriate to the current locale.
| const TDesC8 & aDes | The 8-bit non modifable descriptor whose data is to be compared with this descriptor's data. |
| IMPORT_C TInt | CompareF | ( | const TDesC8 & | aDes | ) | const |
Compares this descriptor's folded data with the specified descriptor's folded data.
Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for comparing strings in natural language; use CompareC() for this.
| const TDesC8 & aDes | The 8-bit non modifable descriptor whose data is to be compared with this descriptor's data. |
| IMPORT_C TInt | Find | ( | const TDesC8 & | aDes | ) | const |
Searches for the first occurrence of the specified data sequence within this descriptor.
Searching always starts at the beginning of this descriptor's data.
| const TDesC8 & aDes | The 8-bit non modifable descriptor containing the data sequence to be searched for. |
| IMPORT_C TInt | Find | ( | const TUint8 * | pS, |
| TInt | aLenS | |||
| ) | const | |||
Searches for the first occurrence of the specified data sequence within this descriptor.
Searching always starts at the beginning of this descriptor's data.
| IMPORT_C TInt | FindC | ( | const TDesC8 & | aDes | ) | const |
Searches for the first occurrence of the specified collated data sequence within this descriptor's collated data.
Searching always starts at the beginning of this descriptor's data. The function uses the standard collation method for narrow text appropriate to the current locale.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor containing the data sequence to be searched for. |
| IMPORT_C TInt | FindC | ( | const TUint8 * | pS, |
| TInt | aLenS | |||
| ) | const | |||
Searches for the first occurrence of the specified collated data sequence within this descriptor's collated data.
Searching always starts at the beginning of this descriptor's data. The function uses the standard collation method for narrow text appropriate to the current locale.
| IMPORT_C TInt | FindF | ( | const TDesC8 & | aDes | ) | const |
Searches for the first occurrence of the specified folded data sequence within this descriptor's folded data.
Searching always starts at the beginning of this descriptor's data.
Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for finding strings in natural language; use FindC() for this.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor containing the data sequence to be searched for. |
| IMPORT_C TInt | FindF | ( | const TUint8 * | pS, |
| TInt | aLenS | |||
| ) | const | |||
Searches for the first occurrence of the specified folded data sequence within this descriptor's folded data.
Searching always starts at the beginning of this descriptor's data.
Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for finding strings in natural language; use FindC() for this.
| IMPORT_C TPtrC8 | Left | ( | TInt | aLength | ) | const |
Extracts the leftmost part of the data.
The function does not cut or remove any data but constructs a non-modifiable pointer descriptor to represent the leftmost part of the data.
| TInt aLength | The length of the data to be extracted. If this value is greater than the length of the descriptor, the function extracts the whole of the descriptor. |
| TInt | Length | ( | ) | const [inline] |
Gets the length of the data.
This is the number of 8-bit values or data items represented by the descriptor.
| IMPORT_C TInt | Locate | ( | TChar | aChar | ) | const |
Searches for the first occurrence of a character within this descriptor's data.
The search starts at the beginning of the data, i.e. at the leftmost position.
| TChar aChar | The character to be found. |
| IMPORT_C TInt | LocateF | ( | TChar | aChar | ) | const |
Searches for the first occurrence of a folded character within this descriptor's folded data.
The search starts at the beginning of the data,i.e. at the leftmost position.
Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for searching strings in natural language.
| TChar aChar | The character to be found. |
| IMPORT_C TInt | LocateReverse | ( | TChar | aChar | ) | const |
Searches for the first occurrence of a character within this descriptor's data, searching from the end of the data.
The search starts at the rightmost position.
| TChar aChar | The character to be found. |
| IMPORT_C TInt | LocateReverseF | ( | TChar | aChar | ) | const |
Searches for the first occurrence of a folded character within this descriptor's folded data, searching from the end of the data.
The search starts at the rightmost position.
Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for searching strings in natural language.
| TChar aChar | The character to be found |
| IMPORT_C TInt | Match | ( | const TDesC8 & | aDes | ) | const |
Searches this descriptor's data for a match with the match pattern supplied in the specified descriptor.
The match pattern can contain the wildcard characters "*" and "?", where "*" matches zero or more consecutive occurrences of any character and "?" matches a single occurrence of any character.
Note that there is no 'escape character', which means that it is not possible to match either the "*" character itself or the "?" character itself using this function.
| const TDesC8 & aDes | An 8-bit non-modifable descriptor containing the match pattern. |
| IMPORT_C TInt | MatchC | ( | const TDesC8 & | aDes | ) | const |
Searches this descriptor's collated data for a match with the collated match pattern supplied in the specified descriptor.
The function uses the standard collation method for narrow text appropriate to the current locale.
The match pattern can contain the wildcard characters "*" and "?", where "*" matches zero or more consecutive occurrences of any character and "?" matches a single occurrence of any character.
Note that there is no 'escape character', which means that it is not possible to match either the "*" character itself or the "?" character itself using this function.
| const TDesC8 & aDes | An 8-bit non-modifable descriptor containing the match pattern. |
| IMPORT_C TInt | MatchF | ( | const TDesC8 & | aDes | ) | const |
Searches this descriptor's folded data for a match with the folded match pattern supplied in the specified descriptor.
The match pattern can contain the wildcard characters "*" and "?", where "*" matches zero or more consecutive occurrences of any character and "?" matches a single occurrence of any character.
Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for matching strings in natural language; use MatchC() for this.
Note that there is no 'escape character', which means that it is not possible to match either the "*" character itself or the "?" character itself using this function.
| const TDesC8 & aDes | An 8-bit non-modifable descriptor containing the match pattern. |
| IMPORT_C TPtrC8 | Mid | ( | TInt | aPos | ) | const |
Extracts a portion of the data.
The function does not cut or remove any data but constructs a non-modifiable pointer descriptor to represent the defined portion.
The portion is identified by its starting position and by the length of the remainder of the data starting from the specified position.
| TInt aPos | The starting position of the data to be extracted. This is an offset value; a zero value refers to the leftmost data position. |
| IMPORT_C TPtrC8 | Mid | ( | TInt | aPos, |
| TInt | aLength | |||
| ) | const | |||
Extracts a portion of the data.
The function does not cut or remove any data but constructs a non-modifiable pointer descriptor to represent the defined portion.
The portion is identified by its starting position and by its length.
| IMPORT_C const TUint8 * | Ptr | ( | ) | const |
Gets a pointer to the data represented by the descriptor.
The data cannot be changed through the returned pointer.
| IMPORT_C TPtrC8 | Right | ( | TInt | aLength | ) | const |
Extracts the rightmost part of the data.
The function does not cut or remove any data but constructs a non-modifiable pointer descriptor to represent the rightmost part of the data.
| TInt aLength | The length of data to be extracted. If this value is greater than the length of the descriptor, the function extracts the whole of the descriptor. |
| TInt | Size | ( | ) | const [inline] |
Gets the size of the data.
This is the number of bytes occupied by the data represented by the descriptor.
| TBool | operator!= | ( | const TDesC8 & | aDes | ) | const [inline] |
Determines whether this descriptor's data is not equal to the specified descriptor's data.
The comparison is implemented using the Compare() member function.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| TBool | operator< | ( | const TDesC8 & | aDes | ) | const [inline] |
Determines whether this descriptor's data is less than the specified descriptor's data.
The comparison is implemented using the Compare() member function.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| TBool | operator<= | ( | const TDesC8 & | aDes | ) | const [inline] |
Determines whether this descriptor's data is less than or equal to the specified descriptor's data.
The comparison is implemented using the Compare() member function.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| TBool | operator== | ( | const TDesC8 & | aDes | ) | const [inline] |
Determines whether this descriptor's data is equal to the specified descriptor's data.
The comparison is implemented using the Compare() member function.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| TBool | operator> | ( | const TDesC8 & | aDes | ) | const [inline] |
Determines whether this descriptor's data is greater than the specified descriptor's data.
The comparison is implemented using the Compare() member function.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| TBool | operator>= | ( | const TDesC8 & | aDes | ) | const [inline] |
Determines whether this descriptor's data is greater than or equal to the specified descriptor's data.
The comparison is implemented using the Compare() member function.
| const TDesC8 & aDes | The 8-bit non-modifable descriptor whose data is to be compared with this descriptor's data. |
| const TUint8 & | operator[] | ( | TInt | anIndex | ) | const [inline] |
Gets a reference to a single data item within this descriptor's data.
| TInt anIndex | The position of the individual data item within the descriptor's data. This is an offset value; a zero value refers to the leftmost data position. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.