Class TPtr8

class TPtr8 : public TDes8;

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.

Derivation

• TDesC8 - Abstract base class for 8-bit non-modifiable descriptors

• TDes8 - Abstract base class for 8-bit modifiable descriptors

• TPtr8 - 8-bit modifiable pointer descriptor

Members

Defined in TPtr8:
Set(), Set(), TPtr8(), TPtr8(), iPtr, operator=(), operator=(), operator=()

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

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

See also:

• TPtr
• TPtrC8
• TDesC8
• TDes8
• TBufC8
• TBuf8
• HBufC8

IMPORT_C TPtr8(TUint8 *aBuf, TInt aMaxLength);

Description

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

TUint8 *aBuf A pointer to the location that the descriptor is to represent. TInt aMaxLength The maximum length of the descriptor.

Panic codes

USER 30 if aMaxLength is negative.

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

Description

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

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

inline TPtr8 &operator=(const TUint8 *aString);

Description

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

const TUint8 *aString A pointer to a zero-terminated string.

Return value

TPtr8 & 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.

inline TPtr8 &operator=(const TDesC8 &aDes);

Description

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

const TDesC8 &aDes An 8-bit modifiable pointer descriptor whose data is to be copied into this descriptor.

Return value

TPtr8 & 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.

inline TPtr8 &operator=(const TPtr8 &aPtr);

Description

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

const TPtr8 &aPtr An 8-bit modifiable pointer descriptor whose data is to be copied into this descriptor.

Return value

TPtr8 & 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.

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

Description

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

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

inline void Set(const TPtr8 &aPtr);

Description

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

const TPtr8 &aPtr The source 8-bit modifiable pointer descriptor.

protected: TUint8 * iPtr;

Description