Class TPtr16

TPtr16

Support

Supported from 5.0

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.

Derivation

TDes16 Modifiable 16 bit descriptor; abstract class TDesC16 Abstract base class for 16 bit descriptors TPtr16 16 bit modifiable pointer descriptor

Defined in TPtr16:
Set(), TPtr16(), operator=()

Inherited from TDes16:
Append(), AppendFill(), AppendFormat(), AppendFormatList(), AppendJustify(), AppendNum(), AppendNumFixedWidth(), AppendNumFixedWidthUC(), AppendNumUC(), Capitalize(), Collate(), Copy(), CopyC(), CopyCP(), CopyF(), CopyLC(), CopyUC(), Delete(), Fill(), FillZ(), Fold(), Format(), FormatList(), Insert(), Justify(), LowerCase(), MaxLength(), MaxSize(), Num(), NumFixedWidth(), NumFixedWidthUC(), NumUC(), PtrZ(), Repeat(), Replace(), SetLength(), SetMax(), Swap(), Trim(), TrimAll(), TrimLeft(), TrimRight(), UpperCase(), Zero(), ZeroTerminate(), operator+=(), operator=, operator[]()

Inherited from TDesC16:
Alloc(), AllocL(), AllocLC(), Compare(), CompareC(), CompareF(), Find(), FindC(), FindF(), Left(), Length(), Locate(), LocateF(), LocateReverse(), LocateReverseF(), Match(), MatchC(), MatchF(), Mid(), Ptr(), Right(), Size(), operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=()

See also:

• TPtrC16
• TDesC16
• TDes16
• TBufC16
• TBuf16
• HBufC16

TPtr16(const TPtr16& aTPtr);

Description

Copy constructor.

Constructs the 16 bit modifiable pointer descriptor from an existing 16 bit 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

const TPtr16& aTPtr The source 16 bit modifiable pointer descriptor

TPtr16(TUint16* aBuf,TInt aMaxLength);

Description

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.

Parameters

const TUint16* aBuf A pointer to the location that the descriptor is to represent. TInt aMaxLength The maximum length of the descriptor. This value must be non-negative otherwise the constructor raises a USER 18 panic.

TPtr16(TUint16* aBuf,TInt aLength,TInt aMaxLength);

Description

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.

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 and must not be greater than the maximum length, otherwise the constructor raises a USER 8 panic. TInt aMaxLength The maximum length of the descriptor. This value must be non-negative, otherwise the constructor raises a USER 18 panic.

void Set(TPtr16& aPtr);

Description

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

const TPtr16& aTPtr The source 16 bit modifiable pointer descriptor

void Set(TUint16* aBuf,TInt aLength,TInt aMaxLength);

Description

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

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 and must not be greater than the maximum length, otherwise the constructor raises a USER 8 panic. TInt aMaxLength The maximum length of the descriptor. This value must be non-negative, otherwise the constructor raises a USER 18 panic.

TPtr16& operator=(const TDesC16& aDes);
TPtr16& operator=(const TPtr16& aDes);
TPtr16& operator=(const TUint16* aString);

Description

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

const TDesC16& aDes A 16 bit non-modifiable descriptor whose data is to be copied into this descriptor. The length of the data cannot be greater than the maximum length of this descriptor otherwise the function raises a USER 11 panic. const TPtr16& aDes A 16 bit modifiable pointer descriptor whose data is to be copied into this descriptor. The length of the data cannot be greater than the maximum length of this descriptor otherwise the function raises a USER 11 panic const TUint16* aString A pointer to a zero-terminated string. The length of the string, excluding the zero terminator, must not be greater than the maximum length of this descriptor, otherwise the function raises a USER 11 panic.

Return value

TPtr16& A reference to this 16 bit modifiable pointer descriptor