TBuf16 Class Reference

#include <e32des16.h>

class TBuf16 : public TBufBase16

Inherits from

TBuf16
- TBufBase16
  - TDes16
    - TDesC16

Protected Attributes
TUint16	iBuf

Public Member Functions
	TBuf16()
	TBuf16(TInt)
	TBuf16(const TUint16 *)
	TBuf16(const TDesC16 &)
TBuf16< S > &	operator=(const TUint16 *)
TBuf16< S > &	operator=(const TDesC16 &)
TBuf16< S > &	operator=(const TBuf16< S > &)

Inherited Attributes
	TDes16::__DECLARE_TEST
	TDes16::iMaxLength

Inherited Enumerations
	TDesC16:TPrefix

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::Append2(TChar)
	TDes16::AppendFill(TChar,TInt)
	TDes16::AppendFill2(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::AppendJustify2(const TDesC16 &,TInt,TAlign,TChar)
	TDes16::AppendJustify2(const TDesC16 &,TInt,TInt,TAlign,TChar)
	TDes16::AppendJustify2(const TUint16 *,TInt,TAlign,TChar)
	TDes16::AppendJustify2(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::Capitalize2()
	TDes16::Collapse()
	TDes16::Collate()
	TDes16::Collate2()
	TDes16::Copy(const TDesC16 &)
	TDes16::Copy(const TDesC8 &)
	TDes16::Copy(const TUint16 *)
	TDes16::Copy(const TUint16 *,TInt)
	TDes16::CopyC(const TDesC16 &)
	TDes16::CopyC2(const TDesC16 &)
	TDes16::CopyCP(const TDesC16 &)
	TDes16::CopyCP2(const TDesC16 &)
	TDes16::CopyF(const TDesC16 &)
	TDes16::CopyF2(const TDesC16 &)
	TDes16::CopyLC(const TDesC16 &)
	TDes16::CopyLC2(const TDesC16 &)
	TDes16::CopyUC(const TDesC16 &)
	TDes16::CopyUC2(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::Fill2(TChar)
	TDes16::Fill2(TChar,TInt)
	TDes16::FillZ()
	TDes16::FillZ(TInt)
	TDes16::Fold()
	TDes16::Fold2()
	TDes16::Format(TRefByValue< const TDesC16 >,...)
	TDes16::FormatList(const TDesC16 &,VA_LIST)
	TDes16::Insert(TInt,const TDesC16 &)
	TDes16::Justify(const TDesC16 &,TInt,TAlign,TChar)
	TDes16::Justify2(const TDesC16 &,TInt,TAlign,TChar)
	TDes16::LeftTPtr(TInt)const
	TDes16::LowerCase()
	TDes16::LowerCase2()
	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::UpperCase2()
	TDes16::WPtr()const
	TDes16::Zero()
	TDes16::ZeroTerminate()
	TDes16::operator+=(const TDesC16 &)
	TDes16::operator=(const TDes16 &)
	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::FindCorruptSurrogate()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::Locate2(TChar)const
	TDesC16::LocateF(TChar)const
	TDesC16::LocateF2(TChar)const
	TDesC16::LocateReverse(TChar)const
	TDesC16::LocateReverse2(TChar)const
	TDesC16::LocateReverseF(TChar)const
	TDesC16::LocateReverseF2(TChar)const
	TDesC16::Match(const TDesC16 &)const
	TDesC16::Match2(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

Detailed Description

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.

Member Attribute Documentation

iBuf

TUint16

iBuf

[protected]

Constructor & Destructor Documentation

TBuf16 ( )

TBuf16

(

)

[inline]

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 ( TInt )

TBuf16

(

TInt

aLength

)

[inline, explicit]

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
aLength	The length of this modifiable buffer descriptor.

Panic Codes
USER	8, if aLength is negative or is greater than the value of the integer template parameter.

TBuf16 ( const TUint16 * )

TBuf16

(

const TUint16 *

aString

)

[inline]

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

The integer template parameter determines the size of the data area that 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.

Parameters
aString	A pointer to a zero terminated string.

Panic Codes
USER	11, if the length of the string, excluding the zero terminator, is greater than the value of the integer template parameter.

TBuf16 ( const TDesC16 & )

TBuf16

(

const TDesC16 &

aDes

)

[inline]

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.

Parameters
aDes	The source 16-bit non-modifiable descriptor.

Panic Codes
USER	11, if the length of the source descriptor is greater than the value of the integer template parameter.

Member Function Documentation

operator= ( const TUint16 * )

TBuf16< S > &

operator=

(

const TUint16 *

aString

)

[inline]

Reimplemented from TDes16::operator=(const TUint16 *)

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
aString	A pointer to a zero-terminated string.

Return Value: 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.

operator= ( const TDesC16 & )

TBuf16< S > &

operator=

(

const TDesC16 &

aDes

)

[inline]

Reimplemented from TDes16::operator=(const TDesC16 &)

Copies data into this 16-bit modifiable descriptor, replacing any existing data.

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

Parameters
aDes	A 16-bit non-modifiable descriptor.

Return Value: 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.

operator= ( const TBuf16< S > & )

TBuf16< S > &

operator=

(

const TBuf16< S > &

aDes

)

[inline]

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
aDes	The source 16-bit modifiable buffer descriptor with the same template value.

Return Value: A reference to this 16-bit modifiable buffer descriptor.

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