TPtr8 Class Reference

#include <e32des8.h>

class TPtr8 : public TDes8

Inherits from

TPtr8
- TDes8
  - TDesC8

Protected Attributes
TUint8 *	iPtr

Public Member Functions
	TPtr8(TUint8 *, TInt)
	TPtr8(TUint8 *, TInt, TInt)
void	Set(TUint8 *, TInt, TInt)
void	Set(const TPtr8 &)
TPtr8 &	operator=(const TUint8 *)
TPtr8 &	operator=(const TDesC8 &)
TPtr8 &	operator=(const TPtr8 &)

Inherited Attributes
	TDes8::iMaxLength

Inherited Functions
	TDes8::Append(TChar)
	TDes8::Append(const TDesC16 &)
	TDes8::Append(const TDesC8 &)
	TDes8::Append(const TUint8 *,TInt)
	TDes8::AppendFill(TChar,TInt)
	TDes8::AppendFormat(TRefByValue< const TDesC8 >,...)
	TDes8::AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)
	TDes8::AppendFormatList(const TDesC8 &,VA_LIST,TDes8Overflow *)
	TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TDesC8 &,TInt,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TUint8 *,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TUint8 *,TInt,TInt,TAlign,TChar)
	TDes8::AppendNum(TInt64)
	TDes8::AppendNum(TReal,const TRealFormat &)
	TDes8::AppendNum(TUint64,TRadix)
	TDes8::AppendNumFixedWidth(TUint,TRadix,TInt)
	TDes8::AppendNumFixedWidthUC(TUint,TRadix,TInt)
	TDes8::AppendNumUC(TUint64,TRadix)
	TDes8::Capitalize()
	TDes8::Collapse()
	TDes8::Collate()
	TDes8::Copy(const TDesC16 &)
	TDes8::Copy(const TDesC8 &)
	TDes8::Copy(const TUint8 *)
	TDes8::Copy(const TUint8 *,TInt)
	TDes8::CopyC(const TDesC8 &)
	TDes8::CopyCP(const TDesC8 &)
	TDes8::CopyF(const TDesC8 &)
	TDes8::CopyLC(const TDesC8 &)
	TDes8::CopyUC(const TDesC8 &)
	TDes8::Delete(TInt,TInt)
	TDes8::DoAppendNum(TUint64,TRadix,TUint,TInt)
	TDes8::DoPadAppendNum(TInt,TInt,const TUint8 *)
	TDes8::Expand()
	TDes8::Fill(TChar)
	TDes8::Fill(TChar,TInt)
	TDes8::FillZ()
	TDes8::FillZ(TInt)
	TDes8::Fold()
	TDes8::Format(TRefByValue< const TDesC8 >,...)
	TDes8::FormatList(const TDesC8 &,VA_LIST)
	TDes8::Insert(TInt,const TDesC8 &)
	TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)
	TDes8::LeftTPtr(TInt)const
	TDes8::LowerCase()
	TDes8::MaxLength()const
	TDes8::MaxSize()const
	TDes8::MidTPtr(TInt)const
	TDes8::MidTPtr(TInt,TInt)const
	TDes8::Num(TInt64)
	TDes8::Num(TReal,const TRealFormat &)
	TDes8::Num(TUint64,TRadix)
	TDes8::NumFixedWidth(TUint,TRadix,TInt)
	TDes8::NumFixedWidthUC(TUint,TRadix,TInt)
	TDes8::NumUC(TUint64,TRadix)
	TDes8::PtrZ()
	TDes8::Repeat(const TDesC8 &)
	TDes8::Repeat(const TUint8 *,TInt)
	TDes8::Replace(TInt,TInt,const TDesC8 &)
	TDes8::RightTPtr(TInt)const
	TDes8::SetLength(TInt)
	TDes8::SetMax()
	TDes8::Swap(TDes8 &)
	TDes8::TDes8()
	TDes8::TDes8(TInt,TInt,TInt)
	TDes8::Trim()
	TDes8::TrimAll()
	TDes8::TrimLeft()
	TDes8::TrimRight()
	TDes8::UpperCase()
	TDes8::WPtr()const
	TDes8::Zero()
	TDes8::ZeroTerminate()
	TDes8::operator+=(const TDesC8 &)
	TDes8::operator=(const TDes8 &)
	TDes8::operator[](TInt)
	TDes8::operator[](TInt)const
	TDesC8::Alloc()const
	TDesC8::AllocL()const
	TDesC8::AllocLC()const
	TDesC8::AtC(TInt)const
	TDesC8::Compare(const TDesC8 &)const
	TDesC8::CompareC(const TDesC8 &)const
	TDesC8::CompareF(const TDesC8 &)const
	TDesC8::DoSetLength(TInt)
	TDesC8::Find(const TDesC8 &)const
	TDesC8::Find(const TUint8 *,TInt)const
	TDesC8::FindC(const TDesC8 &)const
	TDesC8::FindC(const TUint8 *,TInt)const
	TDesC8::FindF(const TDesC8 &)const
	TDesC8::FindF(const TUint8 *,TInt)const
	TDesC8::Left(TInt)const
	TDesC8::Length()const
	TDesC8::Locate(TChar)const
	TDesC8::LocateF(TChar)const
	TDesC8::LocateReverse(TChar)const
	TDesC8::LocateReverseF(TChar)const
	TDesC8::Match(const TDesC8 &)const
	TDesC8::MatchC(const TDesC8 &)const
	TDesC8::MatchF(const TDesC8 &)const
	TDesC8::Mid(TInt)const
	TDesC8::Mid(TInt,TInt)const
	TDesC8::Ptr()const
	TDesC8::Right(TInt)const
	TDesC8::Size()const
	TDesC8::TDesC8()
	TDesC8::TDesC8(TInt,TInt)
	TDesC8::Type()const
	TDesC8::operator!=(const TDesC8 &)const
	TDesC8::operator<(const TDesC8 &)const
	TDesC8::operator<=(const TDesC8 &)const
	TDesC8::operator==(const TDesC8 &)const
	TDesC8::operator>(const TDesC8 &)const
	TDesC8::operator>=(const TDesC8 &)const

Detailed 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.

Member Attribute Documentation

iPtr

TUint8 *

iPtr

[protected]

Constructor & Destructor Documentation

TPtr8 ( TUint8 *, TInt )

IMPORT_C	TPtr8	(	TUint8 *	aBuf,
			TInt	aMaxLength
		)

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
aBuf	A pointer to the location that the descriptor is to represent.
aMaxLength	The maximum length of the descriptor.

Panic Codes
USER	30 if aMaxLength is negative.

TPtr8 ( TUint8 *, TInt, TInt )

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

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
aBuf	A pointer to the location that the descriptor is to represent.
aLength	The length of the descriptor.
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.

Member Function Documentation

Set ( TUint8 *, TInt, TInt )

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

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
aBuf	A pointer to the location that the descriptor is to represent.
aLength	The length of the descriptor.
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.

Set ( const TPtr8 & )

void

Set

(

const TPtr8 &

aPtr

)

[inline]

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
aPtr	The source 8-bit modifiable pointer descriptor.

operator= ( const TUint8 * )

TPtr8 &

operator=

(

const TUint8 *

aString

)

[inline]

Reimplemented from TDes8::operator=(const TUint8 *)

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
aString	A pointer to a zero-terminated string.

Return Value: 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.

operator= ( const TDesC8 & )

TPtr8 &

operator=

(

const TDesC8 &

aDes

)

[inline]

Reimplemented from TDes8::operator=(const TDesC8 &)

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
aDes	An 8-bit modifiable pointer descriptor whose data is to be copied into this descriptor.

Return Value: 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.

operator= ( const TPtr8 & )

TPtr8 &

operator=

(

const TPtr8 &

aPtr

)

[inline]

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
aPtr	An 8-bit modifiable pointer descriptor whose data is to be copied into this descriptor.

Return Value: 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.