Class TPtr8

class TPtr8 : public TDes8;

Description

8-bit modifiable pointer descriptor.

This is a descriptor class intended for instantiation and encapsulates a pointer to the 8-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

• TDesC8 - Abstract base class for 8-bit non-modifiable descriptors.

• TDes8 - Abstract base class for 8-bit modifiable descriptors.

• TPtr8 - 8-bit modifiable pointer descriptor.

Members

Defined in TPtr8:

• Set(TUint8 *,TInt,TInt)Sets the 8-bit modifiable pointer descriptor to point to the specified location ...
• Set(const TPtr8 &)Sets the 8-bit modifiable pointer descriptor from an existing 8-bit modifiable p...
• TPtr8(TUint8 *,TInt)Constructs the 8-bit modifiable pointer descriptor to point to the specified loc...
• TPtr8(TUint8 *,TInt,TInt)Constructs the 8-bit modifiable pointer descriptor to point to the specified loc...
• iPtr
• operator=(const TDesC8 &)Copies data into this 8-bit modifiable pointer descriptor replacing any existing...
• operator=(const TPtr8 &)Copies data into this 8-bit modifiable pointer descriptor replacing any existing...
• operator=(const TUint8 *)Copies data into this 8-bit modifiable pointer descriptor replacing any existing...

Inherited from TDes8:

• Append(TChar)Appends a character onto the end of this descriptor's data.
• Append(const TDesC16 &)Appends data onto the end of this descriptor's data.
• Append(const TDesC8 &)Appends data onto the end of this descriptor's data.
• Append(const TUint8 *,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 TDesC8 >,...)Formats and appends text onto the end of this descriptor's data.
• AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)Formats and appends text onto the end of this descriptor's data.
• AppendFormatList(const TDesC8 &,VA_LIST,TDes8Overflow *)Formats and appends text onto the end of this descriptor's data.
• AppendJustify(const TDesC8 &,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.
• AppendJustify(const TDesC8 &,TInt,TInt,TAlign,TChar)Appends data onto the end of this descriptor's data and justifies it.
• AppendJustify(const TUint8 *,TInt,TAlign,TChar)Appends a zero terminated string onto the end of this descriptor's data and just...
• AppendJustify(const TUint8 *,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 unsigned integer into a character representation b...
• 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 unsigned integer into a character representation b...
• Capitalize()Capitalises the content of this descriptor.
• Collapse()Collapse all characters from 16 to 8 bits
• Collate()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 TUint8 *)Copies data into this descriptor replacing any existing data.
• Copy(const TUint8 *,TInt)Copies data into this descriptor replacing any existing data.
• CopyC(const TDesC8 &)Copies and collates data from the specified descriptor into this descriptor repl...
• CopyCP(const TDesC8 &)Copies text from the specified descriptor and capitalises it before putting it i...
• CopyF(const TDesC8 &)Copies and folds data from the specified descriptor into this descriptor replaci...
• CopyLC(const TDesC8 &)Copies text from the specified descriptor and converts it to lower case before p...
• CopyUC(const TDesC8 &)Copies text from the specified descriptor and converts it to upper case before p...
• Delete(TInt,TInt)Deletes data from this descriptor.
• Expand()Expand all characters from 8 to 16 bits
• 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. 0x00, replacing any ex...
• FillZ(TInt)Fills the descriptor's data area with binary zeroes, i.e. 0x00, replacing any ex...
• Fold()Performs folding on the content of this descriptor.
• Format(TRefByValue< const TDesC8 >,...)Formats and copies text into this descriptor, replacing any existing data.
• FormatList(const TDesC8 &,VA_LIST)Formats and copies text into this descriptor, replacing any existing data.
• Insert(TInt,const TDesC8 &)Inserts data into this descriptor.
• Justify(const TDesC8 &,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 TDesC8 &)Copies data with repetition into this descriptor, from another descriptor, repla...
• Repeat(const TUint8 *,TInt)Copies data with repetition into this descriptor, from a memory location specifi...
• Replace(TInt,TInt,const TDesC8 &)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(TDes8 &)Swaps the data represented by this descriptor with the data represented by the s...
• TDes8(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()const
• Zero()Sets the length of the data to zero.
• ZeroTerminate()Appends a zero terminator onto the end of this descriptor's data.
• __DECLARE_TEST
• iMaxLength
• operator+=(const TDesC8 &)Appends data onto the end of this descriptor's data and returns a reference to t...
• operator=(const TDes8 &)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 TDesC8:

• Alloc()constCreates a new 8-bit heap descriptor and initialises it with a copy of this descr...
• AllocL()constCreates a new 8-bit heap descriptor and initialises it with a copy of this descr...
• AllocLC()constCreates a new 8-bit heap descriptor, initialises it with a copy of this descript...
• AtC(TInt)const
• Compare(const TDesC8 &)constCompares this descriptor's data with the specified descriptor's data.
• CompareC(const TDesC8 &)constCompares this descriptor's data with the specified descriptor's data using the s...
• CompareF(const TDesC8 &)constCompares this descriptor's folded data with the specified descriptor's folded da...
• DoSetLength(TInt)
• Find(const TDesC8 &)constSearches for the first occurrence of the specified data sequence within this des...
• Find(const TUint8 *,TInt)constSearches for the first occurrence of the specified data sequence within this des...
• FindC(const TDesC8 &)constSearches for the first occurrence of the specified collated data sequence within...
• FindC(const TUint8 *,TInt)constSearches for the first occurrence of the specified collated data sequence within...
• FindF(const TDesC8 &)constSearches for the first occurrence of the specified folded data sequence within t...
• FindF(const TUint8 *,TInt)constSearches for the first occurrence of the specified folded data sequence within t...
• 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 TDesC8 &)constSearches this descriptor's data for a match with the match pattern supplied in t...
• MatchC(const TDesC8 &)constSearches this descriptor's collated data for a match with the collated match pat...
• MatchF(const TDesC8 &)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.
• TDesC8(TInt,TInt)
• Type()const
• operator!=(const TDesC8 &)constDetermines whether this descriptor's data is not equal to the specified descript...
• operator>(const TDesC8 &)constDetermines whether this descriptor's data is greater than the specified descript...
• operator>=(const TDesC8 &)constDetermines whether this descriptor's data is greater than or equal to the specif...
• operator<(const TDesC8 &)constDetermines whether this descriptor's data is less than the specified descriptor'...
• operator<=(const TDesC8 &)constDetermines whether this descriptor's data is less than or equal to the specified...
• operator==(const TDesC8 &)constDetermines whether this descriptor's data is equal to the specified descriptor's...

See also:

• TBuf8A descriptor class which provides a buffer of fixed length for containing, acces...

IMPORT_C TPtr8(TUint8 *aBuf, TInt aMaxLength);

Description

Constructs the 8-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

TUint8 *aBuf A pointer to the location that the descriptor is to represent. TInt aMaxLength The maximum length of the descriptor.

Panic codes

USER 30 if aMaxLength is negative.

IMPORT_C TPtr8(TUint8 *aBuf, TInt aLength, TInt aMaxLength);

Description

Constructs the 8-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

TUint8 *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 20 if aLength is negative, or is greater than the descriptor's maximum length, USER 30 if aMaxLength is negative.

inline TPtr8& operator=(const TUint8 *aString);

Description

Copies data into this 8-bit modifiable pointer descriptor replacing any existing data.

The length of this descriptor is set to reflect the new data.

Parameters

const TUint8 *aString A pointer to a zero-terminated string.

Return value

TPtr8 & A reference to this 8-bit modifiable pointer descriptor.

Panic codes

USER 23, if the length of the string, excluding the zero terminator, is greater than the maximum length of this descriptor.

inline TPtr8& operator=(const TDesC8 &aDes);

Description

Copies data into this 8-bit modifiable pointer descriptor replacing any existing data.

The length of this descriptor is set to reflect the new data.

Parameters

const TDesC8 &aDes An 8-bit modifiable pointer descriptor whose data is to be copied into this descriptor.

Return value

TPtr8 & A reference to this 8-bit modifiable pointer descriptor.

Panic codes

USER 23, if the length of aDes is greater than the maximum length of this descriptor.

inline TPtr8& operator=(const TPtr8 &aPtr);

Description

Copies data into this 8-bit modifiable pointer descriptor replacing any existing data.

The length of this descriptor is set to reflect the new data.

Parameters

const TPtr8 &aPtr An 8-bit modifiable pointer descriptor whose data is to be copied into this descriptor.

Return value

TPtr8 & A reference to this 8-bit modifiable pointer descriptor.

Panic codes

USER 23, if the length of aDes is greater than the maximum length of this descriptor.

inline void Set(TUint8 *aBuf, TInt aLength, TInt aMaxLength);

Description

Sets the 8-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

TUint8 *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 20, if aLength is negative or is greater than the maximum length of this descriptor. USER 30, if aMaxLength is negative.

inline void Set(const TPtr8 &aPtr);

Description

Sets the 8-bit modifiable pointer descriptor from an existing 8-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 TPtr8 &aPtr The source 8-bit modifiable pointer descriptor.

protected: TUint8 * iPtr;

Description