Class TPtrC8

class TPtrC8 : public TDesC8;

Description

8-bit non-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, but not changed, through this descriptor. The base class provides the functions through which data is accessed.

Derivation

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

• TPtrC8 - 8-bit non-modifiable pointer descriptor.

Members

Defined in TPtrC8:

• Set(const TDesC8 &)Sets the 8-bit non-modifiable pointer descriptor from the specified descriptor.
• Set(const TPtrC8 &)Sets the 8-bit non-modifiable pointer descriptor from the specified non-modifiab...
• Set(const TUint8 *,TInt)Sets the 8-bit non-modifiable pointer descriptor to point to the specified locat...
• TPtrC8()Default constructor.
• TPtrC8(const TDesC8 &)Constructs the 8-bit non-modifiable pointer descriptor from any existing descrip...
• TPtrC8(const TUint8 *)Constructs the 8-bit non-modifiable pointer descriptor to point to a zero termin...
• TPtrC8(const TUint8 *,TInt)Constructs the 8-bit non-modifiable pointer descriptor to point to the specified...
• iPtr

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...
• operator[](TInt)constGets a reference to a single data item within this descriptor's data.

See also:

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

IMPORT_C TPtrC8();

Description

Default constructor.

Constructs an empty 8-bit non-modifiable pointer descriptor.

It represents no data and its length is zero.

The non-modifiable pointer descriptor can, subsequently, be set to represent data.

See also:

• TPtrC8::Set(const TUint8 *,TInt)Sets the 8-bit non-modifiable pointer descriptor to point to the specified locat...

IMPORT_C TPtrC8(const TDesC8 &aDes);

Description

Constructs the 8-bit non-modifiable pointer descriptor from any existing descriptor.

It is set to point to the same data and is given the same length as the source descriptor.

Parameters

const TDesC8 &aDes A reference to an 8bit non-modifiable descriptor.

IMPORT_C TPtrC8(const TUint8 *aString);

Description

Constructs the 8-bit non-modifiable pointer descriptor to point to a zero terminated string, whether in RAM or ROM.

The length of the descriptor is set to the length of the zero terminated string, excluding the zero terminator.

Parameters

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

IMPORT_C TPtrC8(const TUint8 *aBuf, TInt aLength);

Description

Constructs the 8-bit non-modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.

The length of the descriptor is set to the specified length.

Parameters

const TUint8 *aBuf A pointer to the location that the descriptor is to represent. TInt aLength The length of the descriptor. This value must be non-negative.

Panic codes

USER 29 if aLength is negative.

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

Description

Sets the 8-bit non-modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.

The length of the descriptor is set to the specified length.

Parameters

const TUint8 *aBuf A pointer to the location that the descriptor is to represent. TInt aLength The length of the descriptor. This value must be non-negative.

Panic codes

USER 29, if aLength is negative.

inline void Set(const TDesC8 &aDes);

Description

Sets the 8-bit non-modifiable pointer descriptor from the specified descriptor.

It is set to point to the same data and is given the same length.

Parameters

const TDesC8 &aDes A reference to an 8-bit non-modifiable descriptor.

inline void Set(const TPtrC8 &aPtr);

Description

Sets the 8-bit non-modifiable pointer descriptor from the specified non-modifiable pointer descriptor.

It is set to point to the same data and is given the same length.

Parameters

const TPtrC8 &aPtr A reference to an 8-bit non-modifiable pointer descriptor.

protected: const TUint8 * iPtr;

Description