class HBufC16 : public TBufCBase16 |
16-bit heap descriptor.
This is a descriptor class which provides a buffer of fixed length, allocated on the heap, for containing and accessing data.
The class is intended for instantiation.
Heap descriptors have the important property that they can be made larger or smaller, changing the size of the descriptor buffer. This is achieved by reallocating the descriptor. Unlike the behaviour of dynamic buffers, reallocation is not done automatically.
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 (TDesC16) provides the functions through which the data is accessed.
The descriptor is hosted by a heap cell, and the 16-bit data that the descriptor represents is part of the descriptor object itself. The size of the cell depends on the requested maximum length of the descriptor buffer when the descriptor is created or re-allocated.
It is important to note that the size of the allocated cell, and, therefore, the resulting maximum length of the descriptor, may be larger than requested due to the way memory is allocated in Symbian OS. The amount by which this may be rounded up depends on the platform and build type.
Public Member Functions | |
---|---|
IMPORT_C TPtr16 | Des() |
IMPORT_C HBufC16 * | New(TInt) |
IMPORT_C HBufC16 * | NewL(TInt) |
IMPORT_C HBufC16 * | NewL(RReadStream &, TInt) |
IMPORT_C HBufC16 * | NewLC(TInt) |
IMPORT_C HBufC16 * | NewLC(RReadStream &, TInt) |
IMPORT_C HBufC16 * | NewMax(TInt) |
IMPORT_C HBufC16 * | NewMaxL(TInt) |
IMPORT_C HBufC16 * | NewMaxLC(TInt) |
IMPORT_C HBufC16 * | ReAlloc(TInt) |
IMPORT_C HBufC16 * | ReAllocL(TInt) |
IMPORT_C HBufC16 & | operator=(const TUint16 *) |
IMPORT_C HBufC16 & | operator=(const TDesC16 &) |
HBufC16 & | operator=(const HBufC16 &) |
Private Member Functions | |
---|---|
HBufC16(TInt) |
Inherited Enumerations | |
---|---|
TDesC16:TPrefix |
Private Attributes | |
---|---|
__DECLARE_TEST | |
TText16 | iBuf |
IMPORT_C HBufC16 * | NewL | ( | RReadStream & | aStream, |
TInt | aMaxLength | |||
) | [static] |
RReadStream & aStream | |
TInt aMaxLength |
IMPORT_C HBufC16 * | NewLC | ( | RReadStream & | aStream, |
TInt | aMaxLength | |||
) | [static] |
RReadStream & aStream | |
TInt aMaxLength |
IMPORT_C HBufC16 & | operator= | ( | const TUint16 * | aString | ) |
const TUint16 * aString |
IMPORT_C HBufC16 & | operator= | ( | const TDesC16 & | aDes | ) |
const TDesC16 & aDes |
HBufC16 & | operator= | ( | const HBufC16 & | aLcb | ) | [inline] |
Copies data into this 16-bit heap descriptor replacing any existing data.
The length of this descriptor is set to reflect the new data.
Note that the maximum length of this (target) descriptor is the length of the descriptor buffer in the allocated host heap cell; this may be greater than the maximum length specified when this descriptor was created or last re-allocated.
A reference to this 16-bit heap descriptor.
panic
USER 11, if the length of the descriptor aLcb is greater than the maximum length of this (target) descriptor
const HBufC16 & aLcb | The source 16-bit heap descriptor. |