Class TBuf16

TBuf16<TInt>

Support

Supported from 5.0

Description

16 bit modifiable buffer descriptor

This is a descriptor class which provides a buffer of fixed length for containing, accessing and manipulating TUint16 data.

The class is intended for instantiation. The 16 bit data that the descriptor represents is part of the descriptor object itself.

The class is templated, based on an integer value which determines the size of the data area which is created as part of the buffer descriptor object; this is also the maximum length of the descriptor.

The data is intended to be both accessed and modified. The base classes provide the functions through which the data is accessed.

Derivation

TBuf16 16 bit modifiable buffer descriptor TBufBase16 Base class used in the derivation of TBuf16 and TBuf TDes16 Modifiable 16 bit descriptor; abstract class TDesC16 Abstract base class for 16 bit descriptors

Defined in TBuf16:
TBuf16(), 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:

• TDesC16
• TDes16
• TPtr16

TBuf16();

Description

Default constructor.

Constructs an empty 16 bit modifiable buffer descriptor. It contains no data.

The integer template parameter determines the size of the data area created as part of the object and defines the descriptor's maximum length.

TBuf16(const TBuf16<S>& aBuf);

Description

Copy constructor.

Constructs the 16 bit modifiable buffer descriptor from an existing 16 bit modifiable buffer descriptor having the same template value.

The integer template parameter determines the size of the data area created as part of the object and defines the descriptor's maximum length.

Data is copied from the source buffer descriptor into this buffer descriptor and the length of this buffer descriptor is set to the length of the source.

Parameters

const TBuf16<S>& aBuf The source 16 bit modifiable buffer descriptor with the same template length as this descriptor.

TBuf16(TInt aLength);

Description

Constructs an empty 16 bit modifiable buffer descriptor and sets the its length to the specified value. No data is assigned to the descriptor.

The integer template parameter defines the size of the data area created as part of the object and defines the descriptor's maximum length.

Parameters

TInt aLength The length of this modifiable buffer descriptor. This value must be non-negative and must not be greater than the maximum length (the value of the integer template parameter), otherwise the constructor raises a USER 8 panic.

TBuf16(const TDesC16& aDes);

Description

Constructs the 16 bit modifiable buffer descriptor from any existing 16 bit descriptor.

The integer template parameter determines the size of the data area created as part of this object and defines the descriptor's maximum length.

Data is copied from the source descriptor into this modifiable buffer descriptor and the length of this modifiable buffer descriptor is set to the length of the source descriptor.

The length of the source descriptor must not be greater than the value of the integer template parameter, otherwise the constructor raises a USER 11 panic.

Parameters

const TDes16C& aDes The source 16 bit non-modifiable descriptor.

TBuf16(const TUint16* aString);

Description

Constructs the 16 bit modifiable buffer descriptor from a zero terminated string.

The integer template parameter determines the size of the data area is created as part of this object and defines the descriptor's maximum length.

The string, excluding the zero terminator, is copied into this buffer descriptor's data area. The length of this buffer descriptor is set to the length of the string, excluding the zero terminator.

The length of the string, excluding the zero terminator, must not be greater than the value of the integer template parameter, otherwise the constructor raises a USER 11 panic

Parameters

const TUint16* aString A pointer to a zero terminated string.

TBuf16<S>& operator=(const TBuf16<S>& aBuf);
TBuf16<S>& operator=(const TDesC16& aDes);
TBuf16<S>& operator=(const TUint16* aString);

Description

Copies data into this 16 bit modifiable buffer descriptor replacing any existing data. The length of this descriptor is set to reflect the new data.

Parameters

const TBuf16<S>& aBuf The source 16 bit modifiable buffer descriptor with the same template value. const TDesC16& aDes An 16 bit non-modifiable descriptor. The length of the data cannot be greater than the maximum length of the target 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 the target descriptor, otherwise the function raises a USER 11 panic.

Return value

TBuf16<S> A reference to this 16 bit modifiable buffer descriptor.