Collapse all Symbian^3 Application Developer Library

CDir Class Reference

class CDir : public CBase

Array of directory entries that has been read into memory from the file system.

It can be read and sorted by user programs, but cannot be created by them.

Inherits from

CDir
- CBase

Public Member Functions
	~CDir ()
IMPORT_C TInt	Count ()
IMPORT_C TInt	Sort ( TUint )
IMPORT_C const TEntry &	operator[] ( TInt )

Protected Member Functions
	CDir ()
IMPORT_C void	AddL (const TEntry &)
IMPORT_C void	Compress ()
IMPORT_C void	ExtractL ( TBool , CDir *&)
IMPORT_C CDir *	NewL ()

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

Protected Attributes
CArrayPakFlat < TEntry > *	iArray

Constructor & Destructor Documentation

CDir()

IMPORT_C

CDir

(

)

[protected]

Default constructor.

~CDir()

IMPORT_C

~CDir

(

)

[virtual]

Destructor.

Frees all resources owned by the object, prior to its destruction.

Member Functions Documentation

AddL(const TEntry &)

IMPORT_C void

AddL

(

const TEntry &

anEntry

)

[protected]

Adds the specified entry to the directory.

Note that the function can leave.

Parameters

const TEntry & anEntry

The directory entry to be added.

Compress()

IMPORT_C void

Compress

(

)

[protected]

Compresses the directory.

This has the effect of potentially reducing the ammount of storage space required on the media for that directory and the files it contains. Some files are already compressed and will not compress further.

A potential side effect of compression is that each file is required to be uncompressed prior to use, generally increasing the time and processing cycles required to access that file.

Count()

IMPORT_C TInt

Count

(

)

const

Gets the number of entries in the array of directory entries.

ExtractL(TBool, CDir *&)

IMPORT_C void	ExtractL	(	TBool	aRemove,
			CDir *&	aDir
		)	[protected]

Copies all directory entries from this directory array, and adds them to a new directory array.

The directory entries in this array can be deleted.

Note that the function can leave.

Parameters

TBool aRemove	If ETrue, the directory entries in this array are to be deleted after extraction; if EFalse, the directory entries are not to be deleted.
CDir *& aDir	On return, a pointer to a CDir object containing the extracted directory entries.

NewL()

IMPORT_C CDir *

NewL

(

)

[protected, static]

Allocates and constructs a directory object.

This function is protected, which prevents objects of this class from being directly constructed.

Sort(TUint)

IMPORT_C TInt

Sort

(

TUint

aEntrySortKey

)

Sorts the array of directory entries.

TEntryKey

Parameters

TUint aEntrySortKey

A set of flags describing how the directory entries are to be sorted. The set of flags is defined by TEntryKey.

operator[](TInt)

IMPORT_C const TEntry &

operator[]

(

TInt

anIndex

)

const

Gets an entry from the array of directory entries.

Parameters

TInt anIndex

of the desired entry within the array.

Member Data Documentation

CArrayPakFlat< TEntry > * iArray

CArrayPakFlat < TEntry > *

iArray

[protected]