Collapse all Symbian^3 Product Developer Library

TPtrC8 Class Reference

class TPtrC8 : public TDesC8

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.

TPtr8 TDesC8 TDes8 TBufC8 TBuf8 HBufC8

Inherits from

TPtrC8
- TDesC8

Public Member Functions
	TPtrC8()
	TPtrC8(const TDesC8 &)
	TPtrC8(const TUint8 *)
	TPtrC8(const TUint8 *, TInt)
void	Set(const TUint8 *, TInt)
void	Set(const TDesC8 &)
void	Set(const TPtrC8 &)

Private Member Functions
TPtrC8 &	operator=(const TPtrC8 &)

Inherited Functions
	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
	TDesC8::operator[](TInt)const

Protected Attributes
const TUint8 *	iPtr

Private Attributes
	__DECLARE_TEST

Constructor & Destructor Documentation

TPtrC8()

IMPORT_C

TPtrC8

(

)

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.

TPtrC8::Set()

TPtrC8(const TDesC8 &)

IMPORT_C

TPtrC8

(

const TDesC8 &

aDes

)

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.

TPtrC8(const TUint8 *)

IMPORT_C

TPtrC8

(

const TUint8 *

aString

)

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.

TPtrC8(const TUint8 *, TInt)

IMPORT_C	TPtrC8	(	const TUint8 *	aBuf,
			TInt	aLength
		)

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.

panic: USER 29 if aLength is negative.

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.

Member Functions Documentation

Set(const TUint8 *, TInt)

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

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.

panic: USER 29, if aLength is negative.

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.

Set(const TDesC8 &)

void

Set

(

const TDesC8 &

aDes

)

[inline]

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.

Set(const TPtrC8 &)

void

Set

(

const TPtrC8 &

aPtr

)

[inline]

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.

operator=(const TPtrC8 &)

TPtrC8 &

operator=

(

const TPtrC8 &

aDes

)

[private]

Parameters

const TPtrC8 & aDes

Member Data Documentation

__DECLARE_TEST

[private]

const TUint8 * iPtr

const TUint8 *

iPtr

[protected]