ContentAccess::CDirStreamable Class Reference

#include <caf/dirstreamable.h>

class ContentAccess::CDirStreamable : public CDir

Inherits from

ContentAccess::CDirStreamable

Public Member Functions
virtual	~CDirStreamable()
IMPORT_C void	AddL(const TEntry &)
IMPORT_C TInt	Count()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C CDirStreamable *	NewL()
IMPORT_C CDirStreamable *	NewL(CDir &)
IMPORT_C CDirStreamable *	NewL(RReadStream)
IMPORT_C TInt	Sort(TUint)
IMPORT_C const TEntry &	operator[](TInt)

Inherited Attributes
	CDir::iArray

Inherited Functions
	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()
	CDir::CDir()
	CDir::Compress()
	CDir::ExtractL(TBool,CDir *&)
	CDir::~CDir()

Detailed Description

Emulates the behavior of a CDir object with the addition of streaming.

Functions are not virtual and do not override the CDir functions so most of the time this class will be used as if it was a CDir. It is only when used explicitly as a CDirStreamable that any additional functionality is invoked

Constructor & Destructor Documentation

~CDirStreamable ( )

~CDirStreamable

(

)

[virtual]

Member Function Documentation

AddL ( const TEntry & )

IMPORT_C void

AddL

(

const TEntry &

aEntry

)

Reimplemented from CDir::AddL(const TEntry &)

Add an entry

Parameters
aEntry	The directory entry to add

Count ( )

IMPORT_C TInt

Count

(

)

const

Reimplemented from CDir::Count()const

The number of file system entries in the CDirStreamable

Return Value: The number of TEntry objects in the CDirStreamable

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Write this CDirStreamable to a stream

Parameters
aStream	The stream to write to

NewL ( )

IMPORT_C CDirStreamable *

NewL

(

)

[static]

Reimplemented from CDir::NewL()

Constuct an empty CDirStreamable

Return Value: a CDirStreamable with no entries

NewL ( CDir & )

IMPORT_C CDirStreamable *

NewL

(

CDir &

aDir

)

[static]

Construct a CDirStreamable object from the result of a call to RFs::GetDir()

Parameters
aDir	A CDir object which has been constructed by a previous call to RFs::GetDir()

Return Value: A new CDirStreamable object

NewL ( RReadStream )

IMPORT_C CDirStreamable *

NewL

(

RReadStream

aStream

)

[static]

Construct a CDirStreamable object from a stream

Parameters
aStream	The stream to read the CDirStreamable object from

Return Value: A new CDirStreamable object

Sort ( TUint )

IMPORT_C TInt

Sort

(

TUint

aEntrySortKey

)

Reimplemented from CDir::Sort(TUint)

Sort the entries in the specified order

Parameters
aEntrySortKey	A TEntryKey value used to sort the array.

Return Value: KErrNone if sort was successful

operator[] ( TInt )

IMPORT_C const TEntry &

operator[]

(

TInt

aIndex

)

const

Reimplemented from CDir::operator[](TInt)const

Retrieve the file system entry at a particular index