Class TBufC16

TBufC16<TInt>

Support

Supported from 5.0

Description

16-bit non-modifiable buffer descriptor. This is a descriptor class which provides a buffer of fixed length for containing and accessing TUint16 data.

The class 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 defines the size of the descriptor's data area.

The data is intended to be accessed, but not modified; however, it can be completely replaced using the assignment operators of this class. The base class provides the functions through which the data is accessed.

Derivation

TBufC16 16-bit non-modifiable buffer descriptor TBufCBase16 Base class used in the derivation of TBufC16, TBufC and HBufC16 TDesC16 Abstract base class for 16 bit descriptors

Defined in TBufC16:
Des(), TBufC16(), 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>=(), operator[]()

See also:

• TDesC16
• TPtr16

TBufC16();

Description

Default constructor. Constructs an empty 16 bit non-modifiable buffer descriptor. It contains no data.

The integer template parameter determines the size of the data area which is created as part of the buffer descriptor object.

Data can, subsequently, be assigned into this buffer descriptor using the assignment operators.

See also:

• TBufC16::operator=()

TBufC16(const TBufC16<S>& aLcb);

Description

Copy constructor. Constructs the 16 bit non-modifiable buffer descriptor from an existing 16 bit non-modifiable buffer descriptor which has the same template value.

The integer template parameter of this buffer descriptor determines the size of the data area which is created as part of this object.

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 TBufC16<S>& aLcb The source 16 bit non-modifiable buffer descriptor with the same template length as this descriptor.

TBufC16(const TDesC16& aDes);

Description

Construction from any 16 bit descriptor. Constructs the 16 bit non-modifiable buffer descriptor from any existing descriptor.

The integer template parameter determines the size of the data area which is created as part of this object.

Data is copied from the source descriptor into this buffer descriptor and the length of this 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 8 panic.

Parameters

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

TBufC16(const TUint16* aString);

Description

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

The integer template parameter determines the size of the data area which is created as part of this object.

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 8 panic

Parameters

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

TBufC16<S> operator=(const TBufC16<S>& aLcb);
TBufC16<S> operator=(const TDesC16& aDes);
TBufC16<S> operator=(const TUint16* aString);

Description

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

Parameters

const TBufC16<S>& aLcb The source 16 bit non-modifiable buffer descriptor with the same template value. const TDesC16& aDes A 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

TBufC16& A reference to this 16 bit non-modifiable buffer descriptor.

TPtr16 Des();

Description

Returns a 16 bit modifiable pointer descriptor. Creates and returns a 16 bit modifiable pointer descriptor for the data represented by this 16 bit non-modifiable buffer descriptor.

The content of a non-modifiable buffer descriptor normally cannot be altered, other than by complete replacement of the data. Creating a modifiable pointer descriptor provides a way of changing the data.

The modifiable pointer descriptor is set to point to this non-modifiable buffer descriptor's data.

The length of the modifiable pointer descriptor is set to the length of this non-modifiable buffer descriptor.

The maximum length of the modifiable pointer descriptor is set to the value of the integer template parameter.

When data is modified through this new pointer descriptor, the lengths of both it and this constant buffer descriptor are changed.

Return value

TPtr16 A 16 bit modifiable pointer descriptor representing the data in this 16 bit non-modifiable buffer descriptor.