CArrayFix< TAny > Class Template Reference

#include <e32base.h>

template <>

class CArrayFix< TAny > : public CArrayFixBase

Inherits from

CArrayFix< TAny >
- CArrayFixBase
  - CBase

Public Member Functions
	CArrayFix(TBufRep, TInt, TInt)
void	AppendL(const TAny *)
void	AppendL(const TAny *, TInt)
const TAny *	At(TInt)
TAny *	At(TInt)
const TAny *	Back(TInt)
TAny *	Back(TInt)
const TAny *	End(TInt)
TAny *	End(TInt)
TAny *	ExtendL()

Inherited Functions
	CArrayFixBase::AtR(const CBase *,TInt)
	CArrayFixBase::CArrayFixBase(TBufRep,TInt,TInt)
	CArrayFixBase::Compress()
	CArrayFixBase::Count()const
	CArrayFixBase::CountR(const CBase *)
	CArrayFixBase::Delete(TInt)
	CArrayFixBase::Delete(TInt,TInt)
	CArrayFixBase::ExpandL(TInt)
	CArrayFixBase::Find(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::FindIsq(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::InsertIsqAllowDuplicatesL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertIsqL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertL(TInt,const TAny *)
	CArrayFixBase::InsertL(TInt,const TAny *,TInt)
	CArrayFixBase::InsertRepL(TInt,const TAny *,TInt)
	CArrayFixBase::Length()const
	CArrayFixBase::Reset()
	CArrayFixBase::ResizeL(TInt,const TAny *)
	CArrayFixBase::SetKey(TKeyArrayFix &)const
	CArrayFixBase::SetReserveFlatL(TInt)
	CArrayFixBase::Sort(TKeyArrayFix &)
	CArrayFixBase::~CArrayFixBase()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

A template specialisation base class for arrays of fixed length untyped objects.

The public functions provide standard array behaviour.

The class is always derived from and is never instantiated explicitly.

Constructor & Destructor Documentation

CArrayFix ( TBufRep, TInt, TInt )

CArrayFix	(	TBufRep	aRep,
		TInt	aRecordLength,
		TInt	aGranularity
	)	[inline]

Member Function Documentation

AppendL ( const TAny * )

void

AppendL

(

const TAny *

aPtr

)

[inline]

Appends the specified untyped element onto the end of the array.

Parameters
aPtr	A pointer to an untyped element to be appended.

Leave Codes
KErrNoMemory	The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves, in which case the array is left in the state it was in before the call.

AppendL ( const TAny *, TInt )

void	AppendL	(	const TAny *	aPtr,
			TInt	aCount
		)	[inline]

Appends one or more untyped elements onto the end of the array.

Parameters
aPtr	A pointer to the first of the contiguous untyped elements to be appended.
aCount	The number of contiguous elements located at aPtr to be appended.

Leave Codes
KErrNoMemory	The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves, in which case the array is left in the state it was in before the call.

Panic Codes
E32USER-CBase	23, if aCount is negative.

At ( TInt )

const TAny *

(

TInt

anIndex

)

const [inline]

Reimplemented from CArrayFixBase::At(TInt)const

Gets a pointer to the untyped element located at the specified position within the array.

Parameters
anIndex	The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return Value: A pointer to the untyped element located at position anIndex within the array.

Panic Codes
E32User-CBase	21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

At ( TInt )

TAny *

(

TInt

anIndex

)

[inline]

Gets a pointer to the untyped element located at the specified position within the array.

Parameters
anIndex	The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return Value: A pointer to the untyped element located at position anIndex within the array.

Panic Codes
E32User-CBase	21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

Back ( TInt )

const TAny *

Back

(

TInt

anIndex

)

const [inline]

Reimplemented from CArrayFixBase::Back(TInt)const

Gets a pointer to the beginning of a contiguous region.

For flat buffers, the function always returns a pointer to the beginning of the buffer.

For segmented buffers, the function returns a pointer to the beginning of the segment for all elements in that segment except the first. If the element at the specified position is the first in a segment, then the function returns a pointer the beginning of the previous segment.

For the first element in the array, the function returns a NULL pointer.

Parameters
anIndex	The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return Value: A pointer to the beginning of the contiguous region.

Panic Codes
E32User-CBase	21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

Back ( TInt )

TAny *

Back

(

TInt

anIndex

)

[inline]

Gets a pointer to the beginning of a contiguous region.

For flat buffers, the function always returns a pointer to the beginning of the buffer.

For the first element in the array, the function returns a NULL pointer.

Parameters
anIndex	The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return Value: A pointer to the beginning of the contiguous region.

Panic Codes
E32User-CBase	21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

End ( TInt )

const TAny *

End

(

TInt

anIndex

)

const [inline]

Reimplemented from CArrayFixBase::End(TInt)const

Gets a pointer to the first byte following the end of the contiguous region containing the element at the specfied position within the array.

For flat buffers, the pointer always points to the first byte following the end of the buffer.

For segmented buffers, the pointer always points to the first byte following the end of the segment which contains the element.

Parameters
anIndex	The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return Value: A pointer to the byte following the end of the contiguous region.

Panic Codes
E32USER-CBase	21, if anIndex is negative or greater than or equal to the number of objects currently within the array.

End ( TInt )

TAny *

End

(

TInt

anIndex

)

[inline]

Gets a pointer to the first byte following the end of the contiguous region containing the element at the specfied position within the array.

For flat buffers, the pointer always points to the first byte following the end of the buffer.

For segmented buffers, the pointer always points to the first byte following the end of the segment which contains the element.

Parameters
anIndex	The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return Value: A pointer to the byte following the end of the contiguous region.

Panic Codes
E32USER-CBase	21, if anIndex is negative or greater than or equal to the number of objects currently within the array.

ExtendL ( )

TAny *

ExtendL

(

)

[inline]

Expands the array by the length of one element at the end of the array and returns a pointer to this new location.

As elements are untyped, no construction is possible and the content of the new location remains undefined.

Return Value: A pointer to the new element location at the end of the array.

Leave Codes
KErrNoMemory	The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves, in which case the array is left in the state it was in before the call.