TBuf Class Reference

class TBuf : public TBufBase16

A build-independent modifiable buffer descriptor.

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

The class is 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 determines the size of the data area 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.

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

TDesC TDesC8 TDesC16 TDes TDes8 TDes16 TPtr TPtr8 TPtr16

Inherits from

Public Member Functions
TBuf()
TBuf(TInt)
TBuf(const TText *)
TBuf(const TDesC &)
TBuf< S > &operator=(const TText *)
TBuf< S > &operator=(const TDesC &)
TBuf< S > &operator=(const TBuf< S > &)
Inherited Functions
TBufBase16::TBufBase16(TInt)
TBufBase16::TBufBase16(TInt,TInt)
TBufBase16::TBufBase16(const TDesC16 &,TInt)
TBufBase16::TBufBase16(const TUint16 *,TInt)
TDes16::Append(TChar)
TDes16::Append(const TDesC16 &)
TDes16::Append(const TUint16 *,TInt)
TDes16::AppendFill(TChar,TInt)
TDes16::AppendFormat(TRefByValue< const TDesC16 >,...)
TDes16::AppendFormat(TRefByValue< const TDesC16 >,TDes16Overflow *,...)
TDes16::AppendFormatList(const TDesC16 &,VA_LIST,TDes16Overflow *)
TDes16::AppendJustify(const TDesC16 &,TInt,TAlign,TChar)
TDes16::AppendJustify(const TDesC16 &,TInt,TInt,TAlign,TChar)
TDes16::AppendJustify(const TUint16 *,TInt,TAlign,TChar)
TDes16::AppendJustify(const TUint16 *,TInt,TInt,TAlign,TChar)
TDes16::AppendNum(TInt64)
TDes16::AppendNum(TReal,const TRealFormat &)
TDes16::AppendNum(TUint64,TRadix)
TDes16::AppendNumFixedWidth(TUint,TRadix,TInt)
TDes16::AppendNumFixedWidthUC(TUint,TRadix,TInt)
TDes16::AppendNumUC(TUint64,TRadix)
TDes16::Capitalize()
TDes16::Collapse()
TDes16::Collate()
TDes16::Copy(const TDesC16 &)
TDes16::Copy(const TDesC8 &)
TDes16::Copy(const TUint16 *)
TDes16::Copy(const TUint16 *,TInt)
TDes16::CopyC(const TDesC16 &)
TDes16::CopyCP(const TDesC16 &)
TDes16::CopyF(const TDesC16 &)
TDes16::CopyLC(const TDesC16 &)
TDes16::CopyUC(const TDesC16 &)
TDes16::Delete(TInt,TInt)
TDes16::DoAppendNum(TUint64,TRadix,TUint,TInt)
TDes16::DoPadAppendNum(TInt,TInt,const TUint8 *)
TDes16::Fill(TChar)
TDes16::Fill(TChar,TInt)
TDes16::FillZ()
TDes16::FillZ(TInt)
TDes16::Fold()
TDes16::Format(TRefByValue< const TDesC16 >,...)
TDes16::FormatList(const TDesC16 &,VA_LIST)
TDes16::Insert(TInt,const TDesC16 &)
TDes16::Justify(const TDesC16 &,TInt,TAlign,TChar)
TDes16::LeftTPtr(TInt)const
TDes16::LowerCase()
TDes16::MaxLength()const
TDes16::MaxSize()const
TDes16::MidTPtr(TInt)const
TDes16::MidTPtr(TInt,TInt)const
TDes16::Num(TInt64)
TDes16::Num(TReal,const TRealFormat &)
TDes16::Num(TUint64,TRadix)
TDes16::NumFixedWidth(TUint,TRadix,TInt)
TDes16::NumFixedWidthUC(TUint,TRadix,TInt)
TDes16::NumUC(TUint64,TRadix)
TDes16::PtrZ()
TDes16::Repeat(const TDesC16 &)
TDes16::Repeat(const TUint16 *,TInt)
TDes16::Replace(TInt,TInt,const TDesC16 &)
TDes16::RightTPtr(TInt)const
TDes16::SetLength(TInt)
TDes16::SetMax()
TDes16::Swap(TDes16 &)
TDes16::TDes16()
TDes16::TDes16(TInt,TInt,TInt)
TDes16::Trim()
TDes16::TrimAll()
TDes16::TrimLeft()
TDes16::TrimRight()
TDes16::UpperCase()
TDes16::WPtr()const
TDes16::Zero()
TDes16::ZeroTerminate()
TDes16::operator+=(const TDesC16 &)
TDes16::operator=(const TDes16 &)
TDes16::operator=(const TUint16 *)
TDes16::operator[](TInt)
TDes16::operator[](TInt)const
TDesC16::Alloc()const
TDesC16::AllocL()const
TDesC16::AllocLC()const
TDesC16::AtC(TInt)const
TDesC16::Compare(const TDesC16 &)const
TDesC16::CompareC(const TDesC16 &)const
TDesC16::CompareC(const TDesC16 &,TInt,const TCollationMethod *)const
TDesC16::CompareF(const TDesC16 &)const
TDesC16::DoSetLength(TInt)
TDesC16::Find(const TDesC16 &)const
TDesC16::Find(const TUint16 *,TInt)const
TDesC16::FindC(const TDesC16 &)const
TDesC16::FindC(const TDesC16 &,TInt &,const TCollationMethod &,TInt)const
TDesC16::FindC(const TUint16 *,TInt)const
TDesC16::FindC(const TUint16 *,TInt,TInt)const
TDesC16::FindF(const TDesC16 &)const
TDesC16::FindF(const TUint16 *,TInt)const
TDesC16::GetCollationKeysL(TInt,const TCollationMethod *)const
TDesC16::GetFoldedDecomposedFormL()const
TDesC16::GetNormalizedDecomposedFormL()const
TDesC16::HasPrefixC(const TDesC16 &,TInt,const TCollationMethod *)const
TDesC16::Left(TInt)const
TDesC16::Length()const
TDesC16::Locate(TChar)const
TDesC16::LocateF(TChar)const
TDesC16::LocateReverse(TChar)const
TDesC16::LocateReverseF(TChar)const
TDesC16::Match(const TDesC16 &)const
TDesC16::MatchC(const TDesC16 &)const
TDesC16::MatchC(const TDesC16 &,TInt,TInt,TInt,TInt,const TCollationMethod *)const
TDesC16::MatchC(const TDesC16 &,const TCollationMethod *,TInt,TInt,TInt,TInt)const
TDesC16::MatchF(const TDesC16 &)const
TDesC16::Mid(TInt)const
TDesC16::Mid(TInt,TInt)const
TDesC16::Ptr()const
TDesC16::Right(TInt)const
TDesC16::Size()const
TDesC16::TDesC16()
TDesC16::TDesC16(TInt,TInt)
TDesC16::Type()const
TDesC16::operator!=(const TDesC16 &)const
TDesC16::operator<(const TDesC16 &)const
TDesC16::operator<=(const TDesC16 &)const
TDesC16::operator==(const TDesC16 &)const
TDesC16::operator>(const TDesC16 &)const
TDesC16::operator>=(const TDesC16 &)const
Inherited Enumerations
TDesC16:TPrefix
Private Attributes
TText iBuf
Inherited Attributes
TDes16::__DECLARE_TEST
TDes16::iMaxLength

Constructor & Destructor Documentation

TBuf()

TBuf()[inline]

Creates a build-independent modifiable buffer descriptor which contains no data.

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

TBuf(TInt)

TBuf(TIntaLength)[inline, explicit]

Constructs an empty build independent modifiable buffer descriptor and sets its length to the specified value.

No data is assigned to the descriptor.

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

panic
USER 8, if aLength is negative and is greater than the value of the integer template parameter for a 16-bit build variant.
panic
USER 20, if aLength is negative and is greater than the value of the integer template parameter for a 8-bit build variant.

Parameters

TInt aLengthThe length of this modifiable buffer descriptor.

TBuf(const TText *)

TBuf(const TText *aString)[inline]

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

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

Parameters

const TText * aStringA pointer to a zero terminated string.

TBuf(const TDesC &)

TBuf(const TDesC &aDes)[inline]

Constructs the build-independent modifiable buffer descriptor from any existing build-independent 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.

panic
USER 11, if the length of the source descriptor is greater than the value of the integer template parameter for a 16-bit build variant.
panic
USER 23, if the length of the source descriptor is greater than the value of the integer template parameter for an 8-bit build variant.

Parameters

const TDesC & aDesThe source build independent non-modifiable descriptor.

Member Functions Documentation

operator=(const TText *)

TBuf< S > &operator=(const TText *aString)[inline]

Parameters

const TText * aString

operator=(const TDesC &)

TBuf< S > &operator=(const TDesC &aDes)[inline]

Copies data into this descriptor replacing any existing data.

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

panic
USER 11, if the length of the descriptor aDes is greater than the maximum length of this (target) descriptor.

Parameters

const TDesC & aDesA 16-bit non-modifiable descriptor.

operator=(const TBuf< S > &)

TBuf< S > &operator=(const TBuf< S > &aBuf)[inline]

Parameters

const TBuf< S > & aBuf

Member Data Documentation

TText iBuf

TText iBuf[private]