TPtr16 Class Reference

#include <e32des16.h>

class TPtr16 : public TDes16

Inherits from

Protected Attributes
TUint16 *iPtr
Public Member Functions
TPtr16(TUint16 *, TInt)
TPtr16(TUint16 *, TInt, TInt)
voidSet(TUint16 *, TInt, TInt)
voidSet(const TPtr16 &)
TPtr16 &operator=(const TUint16 *)
TPtr16 &operator=(const TDesC16 &)
TPtr16 &operator=(const TPtr16 &)
Inherited Attributes
TDes16::iMaxLength
Inherited Enumerations
TDesC16:TPrefix
Inherited Functions
TDes16::Append(TChar)
TDes16::Append(const TDesC16 &)
TDes16::Append(const TUint16 *,TInt)
TDes16::Append2(TChar)
TDes16::AppendFill(TChar,TInt)
TDes16::AppendFill2(TChar,TInt)
TDes16::AppendFormat(TRefByValue< const TDesC16 >,...)
TDes16::AppendFormat(TRefByValue< const TDesC16 >,TDes16Overflow *,...)
TDes16::AppendFormatList(const TDesC16 &,VA_LIST,TDes16Overflow *)
TDes16::AppendJustify(const TDesC16 &,TInt,TAlign,TChar)
TDes16::AppendJustify(const TDesC16 &,TInt,TInt,TAlign,TChar)
TDes16::AppendJustify(const TUint16 *,TInt,TAlign,TChar)
TDes16::AppendJustify(const TUint16 *,TInt,TInt,TAlign,TChar)
TDes16::AppendJustify2(const TDesC16 &,TInt,TAlign,TChar)
TDes16::AppendJustify2(const TDesC16 &,TInt,TInt,TAlign,TChar)
TDes16::AppendJustify2(const TUint16 *,TInt,TAlign,TChar)
TDes16::AppendJustify2(const TUint16 *,TInt,TInt,TAlign,TChar)
TDes16::AppendNum(TInt64)
TDes16::AppendNum(TReal,const TRealFormat &)
TDes16::AppendNum(TUint64,TRadix)
TDes16::AppendNumFixedWidth(TUint,TRadix,TInt)
TDes16::AppendNumFixedWidthUC(TUint,TRadix,TInt)
TDes16::AppendNumUC(TUint64,TRadix)
TDes16::Capitalize()
TDes16::Capitalize2()
TDes16::Collapse()
TDes16::Collate()
TDes16::Collate2()
TDes16::Copy(const TDesC16 &)
TDes16::Copy(const TDesC8 &)
TDes16::Copy(const TUint16 *)
TDes16::Copy(const TUint16 *,TInt)
TDes16::CopyC(const TDesC16 &)
TDes16::CopyC2(const TDesC16 &)
TDes16::CopyCP(const TDesC16 &)
TDes16::CopyCP2(const TDesC16 &)
TDes16::CopyF(const TDesC16 &)
TDes16::CopyF2(const TDesC16 &)
TDes16::CopyLC(const TDesC16 &)
TDes16::CopyLC2(const TDesC16 &)
TDes16::CopyUC(const TDesC16 &)
TDes16::CopyUC2(const TDesC16 &)
TDes16::Delete(TInt,TInt)
TDes16::DoAppendNum(TUint64,TRadix,TUint,TInt)
TDes16::DoPadAppendNum(TInt,TInt,const TUint8 *)
TDes16::Fill(TChar)
TDes16::Fill(TChar,TInt)
TDes16::Fill2(TChar)
TDes16::Fill2(TChar,TInt)
TDes16::FillZ()
TDes16::FillZ(TInt)
TDes16::Fold()
TDes16::Fold2()
TDes16::Format(TRefByValue< const TDesC16 >,...)
TDes16::FormatList(const TDesC16 &,VA_LIST)
TDes16::Insert(TInt,const TDesC16 &)
TDes16::Justify(const TDesC16 &,TInt,TAlign,TChar)
TDes16::Justify2(const TDesC16 &,TInt,TAlign,TChar)
TDes16::LeftTPtr(TInt)const
TDes16::LowerCase()
TDes16::LowerCase2()
TDes16::MaxLength()const
TDes16::MaxSize()const
TDes16::MidTPtr(TInt)const
TDes16::MidTPtr(TInt,TInt)const
TDes16::Num(TInt64)
TDes16::Num(TReal,const TRealFormat &)
TDes16::Num(TUint64,TRadix)
TDes16::NumFixedWidth(TUint,TRadix,TInt)
TDes16::NumFixedWidthUC(TUint,TRadix,TInt)
TDes16::NumUC(TUint64,TRadix)
TDes16::PtrZ()
TDes16::Repeat(const TDesC16 &)
TDes16::Repeat(const TUint16 *,TInt)
TDes16::Replace(TInt,TInt,const TDesC16 &)
TDes16::RightTPtr(TInt)const
TDes16::SetLength(TInt)
TDes16::SetMax()
TDes16::Swap(TDes16 &)
TDes16::TDes16()
TDes16::TDes16(TInt,TInt,TInt)
TDes16::Trim()
TDes16::TrimAll()
TDes16::TrimLeft()
TDes16::TrimRight()
TDes16::UpperCase()
TDes16::UpperCase2()
TDes16::WPtr()const
TDes16::Zero()
TDes16::ZeroTerminate()
TDes16::operator+=(const TDesC16 &)
TDes16::operator=(const TDes16 &)
TDes16::operator[](TInt)
TDes16::operator[](TInt)const
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::FindCorruptSurrogate()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::Locate2(TChar)const
TDesC16::LocateF(TChar)const
TDesC16::LocateF2(TChar)const
TDesC16::LocateReverse(TChar)const
TDesC16::LocateReverse2(TChar)const
TDesC16::LocateReverseF(TChar)const
TDesC16::LocateReverseF2(TChar)const
TDesC16::Match(const TDesC16 &)const
TDesC16::Match2(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

Detailed Description

16-bit 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 and modified through this descriptor. The base classes provide the functions through which the data can be manipulated.

See also: TPtr TPtrC16 TDesC16 TDes16 TBufC16 TBuf16 HBufC16

Member Attribute Documentation

iPtr

TUint16 *iPtr[protected]

Constructor & Destructor Documentation

TPtr16 ( TUint16 *, TInt )

IMPORT_CTPtr16(TUint16 *aBuf,
TIntaMaxLength
)

Constructs the 16-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.

USER 18 if aMaxLength is negative.

Parameters
aBufA pointer to the location that the descriptor is to represent.
aMaxLengthThe maximum length of the descriptor.

TPtr16 ( TUint16 *, TInt, TInt )

IMPORT_CTPtr16(TUint16 *aBuf,
TIntaLength,
TIntaMaxLength
)

Constructs the 16-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.

USER 8 if aLength is negative, or is greater than the descriptor's maximum length,

USER 18 if aMaxLength is negative.

Parameters
aBufA pointer to the location that the descriptor is to represent.
aLengthThe length of the descriptor.
aMaxLengthThe maximum length of the descriptor.

Member Function Documentation

Set ( TUint16 *, TInt, TInt )

voidSet(TUint16 *aBuf,
TIntaLength,
TIntaMaxLength
)[inline]

Sets the 16-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
aBufA pointer to the location that the descriptor is to represent.
aLengthThe length of the descriptor.
aMaxLengthThe maximum length of the descriptor.
Panic Codes
USER8, if aLength is negative or is greater than the maximum length of this descriptor.
USER18, if aMaxLength is negative.

Set ( const TPtr16 & )

voidSet(const TPtr16 &aPtr)[inline]

Sets the 16-bit modifiable pointer descriptor from an existing 16-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
aPtrThe source 16-bit modifiable pointer descriptor.

operator= ( const TUint16 * )

TPtr16 &operator=(const TUint16 *aString)[inline]

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

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

Parameters
aStringA pointer to a zero-terminated string.
Return Value
A reference to this 16-bit modifiable pointer descriptor.
Panic Codes
USER11, if the length of the string, excluding the zero terminator, is greater than the maximum length of this descriptor.

operator= ( const TDesC16 & )

TPtr16 &operator=(const TDesC16 &aDes)[inline]

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

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

Parameters
aDesA 16-bit non-modifiable descriptor whose data is to be copied into this descriptor.
Return Value
A reference to this 16-bit modifiable pointer descriptor.
Panic Codes
USER11, if the length of aDes is greater than the maximum length of this descriptor.

operator= ( const TPtr16 & )

TPtr16 &operator=(const TPtr16 &aDes)[inline]

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

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

Parameters
aDesA 16-bit modifiable pointer descriptor whose data is to be copied into this descriptor.
Return Value
A reference to this 16-bit modifiable pointer descriptor.
Panic Codes
USER11, if the length of aDes is greater than the maximum length of this descriptor.