#include <e32des16.h>
Link against:
euser.lib
class TPtr16 : public TDes16;
Description
16-bit modifiable pointer descriptor
This is a descriptor class intended for instantiation and encapsulates a pointer to the 16-bit data that it represents. The
data can live in ROM or RAM and this location is separate from the descriptor object itself.
The data is intended to be accessed and modified through this descriptor. The base classes provide the functions through which
the data can be manipulated.
Derivation
TDesC16 -
Abstract base class for 16-bit descriptors.
TDes16 -
Abstract base class for 16-bit modifiable descriptors.
TPtr16 -
16-bit modifiable pointer descriptor
Members
Defined in TPtr16:
Inherited from TDes16:
Append(TChar)Appends data onto the end of this descriptor's data.Append(const TDesC16 &)Appends data onto the end of this descriptor's data.Append(const TUint16 *,TInt)Appends data onto the end of this descriptor's data.AppendFill(TChar,TInt)Appends and fills this descriptor with the specified character.AppendFormat(TRefByValue< const TDesC16 >,...)Formats and appends text onto the end of this descriptor's data.AppendFormat(TRefByValue< const TDesC16 >,TDes16Overflow *,...)Formats and appends text onto the end of this descriptor's data.AppendFormatList(const TDesC16 &,VA_LIST,TDes16Overflow *)Formats and appends text onto the end of this descriptor's data.AppendJustify(const TDesC16 &,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.AppendJustify(const TDesC16 &,TInt,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.AppendJustify(const TUint16 *,TInt,TAlign,TChar)Appends a zero terminated string onto the end of this descriptor's data and just...AppendJustify(const TUint16 *,TInt,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.AppendNum(TInt64)Converts the 64-bit signed integer into a decimal character representation and a...AppendNum(TReal,const TRealFormat &)Converts the specified floating point number into a character representation and...AppendNum(TUint64,TRadix)Converts the specified 64 bit integer into a character representation based on t...AppendNumFixedWidth(TUint,TRadix,TInt)Converts the specified unsigned integer into a fixed width character representat...AppendNumFixedWidthUC(TUint,TRadix,TInt)Converts the specified unsigned integer into a fixed width character representat...AppendNumUC(TUint64,TRadix)Converts the specified 64 bit integer into a character representation based on t...Capitalize()Capitalises the content of this descriptor.Collapse()Collapse all characters from 16 to 8 bitsCollate()Performs collation on the content of this descriptor. Copy(const TDesC16 &)Copies data into this descriptor replacing any existing data.Copy(const TDesC8 &)Copies data into this descriptor replacing any existing data.Copy(const TUint16 *)Copies data into this descriptor replacing any existing data.Copy(const TUint16 *,TInt)Copies data into this descriptor replacing any existing data.CopyC(const TDesC16 &)Copies and collates data from the specified descriptor into this descriptor repl...CopyCP(const TDesC16 &)Copies text from the specified descriptor and capitalises it before putting it i...CopyF(const TDesC16 &)Copies and folds data from the specified descriptor into this descriptor replaci...CopyLC(const TDesC16 &)Copies text from the specified descriptor and converts it to lower case before p...CopyUC(const TDesC16 &)Copies text from the specified descriptor and converts it to upper case before p...Delete(TInt,TInt)Deletes data from this descriptor.Fill(TChar)Fills the descriptor's data area with the specified character, replacing any exi...Fill(TChar,TInt)Fills the descriptor's data area with the specified character, replacing any exi...FillZ()Fills the descriptor's data area with binary zeroes, i.e.0x0000, replacing any e...FillZ(TInt)Fills the descriptor's data area with binary zeroes, i.e. 0x0000, replacing any ...Fold()Performs folding on the content of this descriptor.Format(TRefByValue< const TDesC16 >,...)Formats and copies text into this descriptor, replacing any existing data.FormatList(const TDesC16 &,VA_LIST)Formats and copies text into this descriptor, replacing any existing data.Insert(TInt,const TDesC16 &)Inserts data into this descriptor.Justify(const TDesC16 &,TInt,TAlign,TChar)Copies data into this descriptor and justifies it, replacing any existing data.LeftTPtr(TInt)constExtracts the leftmost part of the data.LowerCase()Converts the content of this descriptor to lower case.MaxLength()constGets the maximum length of the descriptor.MaxSize()constGets the maximum size of the descriptor.MidTPtr(TInt)constExtracts a portion of the data.MidTPtr(TInt,TInt)constExtracts a portion of the data.Num(TInt64)Converts the 64-bit signed integer into a decimal character representation and c...Num(TReal,const TRealFormat &)Converts the specified floating point number into a character representation and...Num(TUint64,TRadix)Converts the specified 64 bit unsigned integer into a character representation b...NumFixedWidth(TUint,TRadix,TInt)Converts the specified unsigned integer into a fixed width character representat...NumFixedWidthUC(TUint,TRadix,TInt)Converts the specified unsigned integer into a fixed width character representat...NumUC(TUint64,TRadix)Converts the specified 64 bit unsigned integer into a character representation b...PtrZ()Appends a zero terminator onto the end of this descriptor's data and returns a p...Repeat(const TDesC16 &)Copies data with repetition into this descriptor, from another descriptor, repla...Repeat(const TUint16 *,TInt)Copies data with repetition into this descriptor, from a memory location specifi...Replace(TInt,TInt,const TDesC16 &)Replaces data in this descriptor.RightTPtr(TInt)constExtracts the rightmost part of the data.SetLength(TInt)Sets the length of the data represented by the descriptor to the specified value...SetMax()Sets the length of the data to the maximum length of the descriptor. Swap(TDes16 &)Swaps the data represented by this descriptor with the data represented by the s...TDes16(TInt,TInt,TInt)Trim()Deletes leading and trailing whitespace characters from the descriptor's data.TrimAll()Deletes leading and trailing whitespace characters from the descriptor's data an...TrimLeft()Deletes leading whitespace characters from the descriptor's data.TrimRight()Deletes trailing whitespace characters from the descriptor's data.UpperCase()Converts the content of this descriptor to upper case.WPtr()constZero()Sets the length of the data to zero. ZeroTerminate()Appends a zero terminator onto the end of this descriptor's data.__DECLARE_TESTiMaxLengthoperator+=(const TDesC16 &)Appends data onto the end of this descriptor's data and returns a reference to t...operator=(const TDes16 &)Copies data into this descriptor replacing any existing data.operator[](TInt)Gets a non-const reference to a single data item within this descriptor's data.operator[](TInt)constGets a const reference to a single data item within this descriptor's data.
Inherited from TDesC16:
Alloc()constCreates a new 16-bit heap descriptor and initialises it with a copy of this desc...AllocL()constCreates a new 16-bit heap descriptor and initialises it with a copy of this desc...AllocLC()constCreates a new 16-bit heap descriptor, initialises it with a copy of this descrip...AtC(TInt)constCompare(const TDesC16 &)constCompares this descriptor's data with the specified descriptor's data.CompareC(const TDesC16 &)constCompares this descriptor's data with the specified descriptor's data using the s...CompareC(const TDesC16 &,TInt,const TCollationMethod *)constCompares this descriptor's data with the specified descriptor's data to the spec...CompareF(const TDesC16 &)constCompares this descriptor's folded data with the specified descriptor's folded da...DoSetLength(TInt)EIsNotPrefixIndicates that a supplied prefix cannot be extended to be equivalent to the text...EIsPrefixIndicates that a supplied prefix can be extended to be equivalent to the text at...EMightBePrefixIndicates that a supplied prefix does not seem to be a prefix, but it is possibl...Find(const TDesC16 &)constSearches for the first occurrence of the specified data sequence within this des...Find(const TUint16 *,TInt)constSearches for the first occurrence of the specified data sequence within this des...FindC(const TDesC16 &)constSearches for the first occurrence of the specified collated data sequence within...FindC(const TDesC16 &,TInt &,const TCollationMethod &,TInt)constSearches for the first occurrence of the specified collated data sequence within...FindC(const TUint16 *,TInt)constSearches for the first occurrence of the specified collated data sequence within...FindC(const TUint16 *,TInt,TInt)constSearches for the first occurrence of the specified collated data sequence within...FindF(const TDesC16 &)constSearches for the first occurrence of the specified folded data sequence within t...FindF(const TUint16 *,TInt)constSearches for the first occurrence of the specified folded data sequence within t...HasPrefixC(const TDesC16 &,TInt,const TCollationMethod *)constCompares aPossiblePrefix against the start of the descriptor, using a collated c...Left(TInt)constExtracts the leftmost part of the data.Length()constGets the length of the data.Locate(TChar)constSearches for the first occurrence of a character within this descriptor's data.LocateF(TChar)constSearches for the first occurrence of a folded character within this descriptor's...LocateReverse(TChar)constSearches for the first occurrence of a character within this descriptor's data, ...LocateReverseF(TChar)constSearches for the first occurrence of a folded character within this descriptor's...Match(const TDesC16 &)constSearches this descriptor's data for a match with the match pattern supplied in t...MatchC(const TDesC16 &)constSearches this descriptor's collated data for a match with the collated match pat...MatchC(const TDesC16 &,TInt,TInt,TInt,TInt,const TCollationMethod *)constSearches this descriptor's collated data for a match with the collated match pat...MatchC(const TDesC16 &,const TCollationMethod *,TInt,TInt,TInt,TInt)constSearches this descriptor's collated data for a match with the collated match pat...MatchF(const TDesC16 &)constSearches this descriptor's folded data for a match with the folded match pattern...Mid(TInt)constExtracts a portion of the data.Mid(TInt,TInt)constExtracts a portion of the data.Ptr()constGets a pointer to the data represented by the descriptor.Right(TInt)constExtracts the rightmost part of the data.Size()constGets the size of the data.TDesC16(TInt,TInt)TPrefixA value returned by a call to TDesC16::HasPrefixC(const TDesC16 &,TInt,const...Type()constoperator!=(const TDesC16 &)constDetermines whether this descriptor's data is not equal to the specified descript...operator>(const TDesC16 &)constDetermines whether this descriptor's data is greater than the specified descript...operator>=(const TDesC16 &)constDetermines whether this descriptor's data is greater than or equal to the specif...operator<(const TDesC16 &)constDetermines whether this descriptor's data is less than the specified descriptor'...operator<=(const TDesC16 &)constDetermines whether this descriptor's data is less than or equal to the specified...operator==(const TDesC16 &)constDetermines whether this descriptor's data is equal to the specified descriptor's...
See also:
TBuf16A descriptor class which provides a buffer of fixed length for containing, acces...
Construction and destruction
IMPORT_C TPtr16(TUint16 *aBuf, TInt aMaxLength);
Description
Constructs the 16-bit modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.
The length of the descriptor is set to zero, and its maximum length is set to the specified value.
Parameters
TUint16 *aBuf |
A pointer to the location that the descriptor is to represent.
|
TInt aMaxLength |
The maximum length of the descriptor.
|
|
Panic codes
USER |
18 if aMaxLength is negative.
|
|
TPtr16(TUint16 *,TInt,TInt)
IMPORT_C TPtr16(TUint16 *aBuf, TInt aLength, TInt aMaxLength);
Description
Constructs the 16-bit modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.
The length of the descriptor and its maximum length are set to the specified values.
Parameters
TUint16 *aBuf |
A pointer to the location that the descriptor is to represent.
|
TInt aLength |
The length of the descriptor.
|
TInt aMaxLength |
The maximum length of the descriptor.
|
|
Panic codes
USER |
8 if aLength is negative, or is greater than the descriptor's maximum length,
|
USER |
18 if aMaxLength is negative.
|
|
operator=(const TUint16 *)
inline TPtr16& operator=(const TUint16 *aString);
Description
Copies data into this 16-bit modifiable pointer descriptor replacing any existing data.
The length of this descriptor is set to reflect the new data.
Parameters
const TUint16 *aString |
A pointer to a zero-terminated string.
|
|
Return value
TPtr16 & |
A reference to this 16-bit modifiable pointer descriptor.
|
|
Panic codes
USER |
11, if the length of the string, excluding the zero terminator, is greater than the maximum length of this descriptor.
|
|
operator=(const TDesC16 &)
inline TPtr16& operator=(const TDesC16 &aDes);
Description
Copies data into this 16-bit modifiable pointer descriptor replacing any existing data.
The length of this descriptor is set to reflect the new data.
Parameters
const TDesC16 &aDes |
A 16-bit non-modifiable descriptor whose data is to be copied into this descriptor.
|
|
Return value
TPtr16 & |
A reference to this 16-bit modifiable pointer descriptor.
|
|
Panic codes
USER |
11, if the length of aDes is greater than the maximum length of this descriptor.
|
|
operator=(const TPtr16 &)
inline TPtr16& operator=(const TPtr16 &aDes);
Description
Copies data into this 16-bit modifiable pointer descriptor replacing any existing data.
The length of this descriptor is set to reflect the new data.
Parameters
const TPtr16 &aDes |
A 16-bit modifiable pointer descriptor whose data is to be copied into this descriptor.
|
|
Return value
TPtr16 & |
A reference to this 16-bit modifiable pointer descriptor.
|
|
Panic codes
USER |
11, if the length of aDes is greater than the maximum length of this descriptor.
|
|
inline void Set(TUint16 *aBuf, TInt aLength, TInt aMaxLength);
Description
Sets the 16-bit modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.
The length of the descriptor and its maximum length are set to the specified values.
Parameters
TUint16 *aBuf |
A pointer to the location that the descriptor is to represent.
|
TInt aLength |
The length of the descriptor.
|
TInt aMaxLength |
The maximum length of the descriptor.
|
|
Panic codes
USER |
8, if aLength is negative or is greater than the maximum length of this descriptor.
|
USER |
18, if aMaxLength is negative.
|
|
inline void Set(const TPtr16 &aPtr);
Description
Sets the 16-bit modifiable pointer descriptor from an existing 16-bit modifiable pointer descriptor.
It is set to point to the same data, is given the same length and the same maximum length as the source pointer descriptor.
Parameters
const TPtr16 &aPtr |
The source 16-bit modifiable pointer descriptor.
|
|
protected: TUint16 * iPtr;
Description
![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)