Collapse all Symbian^3 Application Developer Library

TPtrC16 Class Reference

class TPtrC16 : public TDesC16

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

TPtr16 TDesC16 TDes16 TBufC16 TBuf16 HBufC16

Inherits from

TPtrC16
- TDesC16

Public Member Functions
	TPtrC16 ()
	TPtrC16 (const TDesC16 &)
	TPtrC16 (const TUint16 *)
	TPtrC16 (const TUint16 *, TInt )
void	Set (const TUint16 *, TInt )
void	Set (const TDesC16 &)
void	Set (const TPtrC16 &)

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

Inherited Functions
	TDesC16::Alloc()const
	TDesC16::AllocL()const
	TDesC16::AllocLC()const
	TDesC16::AtC(TInt)const
	TDesC16::Compare(const TDesC16 &)const
	TDesC16::CompareC(const TDesC16 &)const
	TDesC16::CompareC(const TDesC16 &,TInt,const TCollationMethod *)const
	TDesC16::CompareF(const TDesC16 &)const
	TDesC16::DoSetLength(TInt)
	TDesC16::Find(const TDesC16 &)const
	TDesC16::Find(const TUint16 *,TInt)const
	TDesC16::FindC(const TDesC16 &)const
	TDesC16::FindC(const TDesC16 &,TInt &,const TCollationMethod &,TInt)const
	TDesC16::FindC(const TUint16 *,TInt)const
	TDesC16::FindC(const TUint16 *,TInt,TInt)const
	TDesC16::FindF(const TDesC16 &)const
	TDesC16::FindF(const TUint16 *,TInt)const
	TDesC16::GetCollationKeysL(TInt,const TCollationMethod *)const
	TDesC16::GetFoldedDecomposedFormL()const
	TDesC16::GetNormalizedDecomposedFormL()const
	TDesC16::HasPrefixC(const TDesC16 &,TInt,const TCollationMethod *)const
	TDesC16::Left(TInt)const
	TDesC16::Length()const
	TDesC16::Locate(TChar)const
	TDesC16::LocateF(TChar)const
	TDesC16::LocateReverse(TChar)const
	TDesC16::LocateReverseF(TChar)const
	TDesC16::Match(const TDesC16 &)const
	TDesC16::MatchC(const TDesC16 &)const
	TDesC16::MatchC(const TDesC16 &,TInt,TInt,TInt,TInt,const TCollationMethod *)const
	TDesC16::MatchC(const TDesC16 &,const TCollationMethod *,TInt,TInt,TInt,TInt)const
	TDesC16::MatchF(const TDesC16 &)const
	TDesC16::Mid(TInt)const
	TDesC16::Mid(TInt,TInt)const
	TDesC16::Ptr()const
	TDesC16::Right(TInt)const
	TDesC16::Size()const
	TDesC16::TDesC16()
	TDesC16::TDesC16(TInt,TInt)
	TDesC16::Type()const
	TDesC16::operator!=(const TDesC16 &)const
	TDesC16::operator<(const TDesC16 &)const
	TDesC16::operator<=(const TDesC16 &)const
	TDesC16::operator==(const TDesC16 &)const
	TDesC16::operator>(const TDesC16 &)const
	TDesC16::operator>=(const TDesC16 &)const
	TDesC16::operator[](TInt)const

Inherited Enumerations
	TDesC16:TPrefix

Protected Attributes
const TUint16 *	iPtr

Private Attributes
	__DECLARE_TEST

Constructor & Destructor Documentation

TPtrC16()

IMPORT_C

TPtrC16

(

)

Constructs an empty 16-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.

TPtrC16::Set()

TPtrC16(const TDesC16 &)

IMPORT_C

TPtrC16

(

const TDesC16 &

aDes

)

Constructs the 16-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 TDesC16 & aDes

A reference to a 16-bit non-modifiable descriptor.

TPtrC16(const TUint16 *)

IMPORT_C

TPtrC16

(

const TUint16 *

aString

)

Constructs the 16-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 TUint16 * aString

A pointer to a zero terminated string.

TPtrC16(const TUint16 *, TInt)

IMPORT_C	TPtrC16	(	const TUint16 *	aBuf,
			TInt	aLength
		)

Constructs the 16-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 17 if aLength is negative.

Parameters

const TUint16 * 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 TUint16 *, TInt)

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

Sets the 16-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 17, if aLength is negative.

Parameters

const TUint16 * 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 TDesC16 &)

void

Set

(

const TDesC16 &

aDes

)

[inline]

Sets the 16-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 TDesC16 & aDes

A reference to a 16-bit non-modifiable descriptor

Set(const TPtrC16 &)

void

Set

(

const TPtrC16 &

aPtr

)

[inline]

Parameters

const TPtrC16 & aPtr

operator=(const TPtrC16 &)

TPtrC16 &

operator=

(

const TPtrC16 &

aDes

)

[private]

Parameters

const TPtrC16 & aDes

Member Data Documentation

__DECLARE_TEST

[private]

const TUint16 * iPtr

const TUint16 *

iPtr

[protected]