Class TBufC

class TBufC : public TBufCBase16;

Description

A build-independent non-modifiable buffer descriptor.

This is a descriptor class which provides a buffer of fixed length for containing and accessing TUint16 or TUint8 data, depending on the build.

The class intended for instantiation. The 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.

This class derives from TBufCBase16 for a Unicode, non-kernel build, but derives from TBufCBase8 for a non-Unicode build.

Derivation

• TBufCBase16 - No description.

• TBufC - A build-independent non-modifiable buffer descriptor.

Members

Defined in TBufC:

• Des()Creates and returns a build-independent modifiable pointer descriptor for the da...
• TBufC()Constructs an empty build independent non-modifiable buffer descriptor.
• TBufC(const TDesC &)Constructs a build-independent non-modifiable buffer descriptor from any existin...
• TBufC(const TText *)Constructs a build independent non-modifiable buffer descriptor from a zero term...
• operator=(const TDesC &)Copies data into this descriptor, replacing any existing data.
• operator=(const TText *)Copies data into this descriptor, replacing any existing data.

inline TBufC();

Description

Constructs an empty build independent 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.

inline TBufC(const TText *aString);

Description

Constructs a build independent 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.

Parameters

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

Panic codes

USER 8, if the length of the string, excluding the zero terminator, is greater than the value of the integer template parameter for the 16-bit build variant. USER 20, if the length of the string, excluding the zero terminator, is greater than the value of the integer template parameter for the 8-bit build variant.

inline TBufC(const TDesC &aDes);

Description

Constructs a build-independent non-modifiable buffer descriptor from any existing build independent 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 20 panic for an 8 bit build variant or a USER 8 panic for a 16 bit (Unicode) build variant.

Parameters

const TDesC16 &aDes The source build independent non-modifiable descriptor.

Panic codes

USER 8, if the length of the source descriptor is greater than the value of the integer template parameter for the 16-bit build variant. USER 20, if the length of the source descriptor is greater than the value of the integer template parameter for the 8-bit build variant.

inline TBufC< S >& operator=(const TText *aString);

Description

Copies data into this descriptor, replacing any existing data.

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

Parameters

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

Return value

TBufC< S > & A reference to this descriptor.

Panic codes

USER 11, if the length of the string, excluding the zero terminator, is greater than the maximum length of this (target) descriptor for the 16-bit build variant. USER 23, if the length of the string, excluding the zero terminator, is greater than the maximum length of this (target) descriptor for the 8-bit build variant.

inline TBufC< S >& operator=(const TDesC &aDes);

Description

Copies data into this descriptor, replacing any existing data.

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

Parameters

const TDesC16 &aDes A build independent non-modifiable descriptor.

Return value

TBufC< S > & A reference to this descriptor.

Panic codes

USER 11, if the length of the descriptor aDes is greater than the maximum length of this (target) descriptor for the 16-bit build variant. USER 23, if the length of the descriptor aDes is greater than the maximum length of this (target) descriptor for the 8-bit build variant.

inline TPtr Des();

Description

Creates and returns a build-independent modifiable pointer descriptor for the data represented by this build-independent 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 build independent modifiable pointer descriptor representing the data in this build independent non-modifiable buffer descriptor.