Class CDir

class CDir : public CBase;

Description

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CDir - Array of directory entries that has been read into memory from the file system

Members

Defined in CDir:

• AddL()Adds the specified entry to the directory
• CDir()Default constructor
• Compress()Compresses the directory
• Count()Gets the number of entries in the array of directory entries
• ExtractL()Copies all directory entries from this directory array, and adds them to a new directory array
• NewL()Allocates and constructs a directory object
• Sort()Sorts the array of directory entries
• iArray
• operator[]()Gets an entry from the array of directory entries
• ~CDir()Destructor

Inherited from CBase:

• Delete()Deletes the specified object
• Extension_()Extension function
• operator new()Initialises the object to binary zeroes

virtual IMPORT_C ~CDir();

Description

Destructor.

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

protected: IMPORT_C CDir();

Description

Default constructor.

protected: static IMPORT_C CDir *NewL();

Description

Allocates and constructs a directory object.

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

Return value

CDir * A pointer to the newly created object.

IMPORT_C TInt Count() const;

Description

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

Return value

TInt The number of entries in the array.

IMPORT_C const TEntry &operator[](TInt anIndex) const;

Description

Gets an entry from the array of directory entries.

Parameters

TInt anIndex of the desired entry within the array.

Return value

const TEntry & A directory entry.

IMPORT_C TInt Sort(TUint aEntrySortKey);

Description

Sorts the array of directory entries.

Parameters

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

Return value

TInt KErrNone, if successful, otherwise one of the other system-wide error codes.

See also:

• TEntryKeyFlags indicating the order in which directory entries are to be sorted

protected: IMPORT_C void AddL(const TEntry &anEntry);

Description

Adds the specified entry to the directory.

Note that the function can leave.

Parameters

const TEntry &anEntry The directory entry to be added.

protected: IMPORT_C void ExtractL(TBool aRemove, CDir *&aDir);

Description

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.

protected: IMPORT_C void Compress();

Description

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.

protected: CArrayPakFlat< TEntry > * iArray;

Description