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

#include <f32file.h>

Inheritance diagram for CDir:

Public Member Functions
virtual IMPORT_C	~CDir ()
	Destructor.

IMPORT_C TInt	Count () const
	Gets the number of entries in the array of directory entries.

IMPORT_C const TEntry &	operator[] (TInt anIndex) const
	Gets an entry from the array of directory entries.

IMPORT_C TInt	Sort (TUint aEntrySortKey)
	Sorts the array of directory entries.

Public Member Functions inherited from CBase
	CBase ()
	Default constructor.

virtual IMPORT_C	~CBase ()
	Virtual destructor.

TAny *	operator new (TUint aSize, TAny *aBase) __NO_THROW
	Initialises the object to binary zeroes.

TAny *	operator new (TUint aSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TUint aExtraSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave, TUint aExtraSize)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

Protected Member Functions
IMPORT_C	CDir ()
	Default constructor.

IMPORT_C void	AddL (const TEntry &anEntry)
	Adds the specified entry to the directory.

IMPORT_C void	ExtractL (TBool aRemove, CDir *&aDir)
	Copies all directory entries from this directory array, and adds them to a new directory array.

IMPORT_C void	Compress ()
	Compresses the directory.

Protected Member Functions inherited from CBase
virtual IMPORT_C TInt	Extension_ (TUint aExtensionId, TAny &a0, TAny a1)
	Extension function.

Static Protected Member Functions
static IMPORT_C CDir *	NewL ()
	Allocates and constructs a directory object.

Protected Attributes
CArrayPakFlat< TEntry > *	iArray

Friends
class	RFs

class	TOpenFileScan

Additional Inherited Members
Static Public Member Functions inherited from CBase
static IMPORT_C void	Delete (CBase *aPtr)
	Deletes the specified object.

Detailed 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.

API status: Published to all clients. Released API.

Definition at line 1963 of file f32file.h.

Constructor & Destructor Documentation

◆ ~CDir()

IMPORT_C CDir::~CDir ( )

virtual

Destructor.

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

(generated from Symbian Developer Library)

◆ CDir()

IMPORT_C CDir::CDir ( )

protected

Default constructor.

(generated from Symbian Developer Library)

Member Function Documentation

◆ AddL()

IMPORT_C void CDir::AddL ( const TEntry & anEntry )

protected

Adds the specified entry to the directory.

Note that the function can leave.

Parameters

anEntry The directory entry to be added.

(generated from Symbian Developer Library)

◆ Compress()

IMPORT_C void CDir::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.

(generated from Symbian Developer Library)

◆ Count()

IMPORT_C TInt CDir::Count ( ) const

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

(generated from Symbian Developer Library)

◆ ExtractL()

IMPORT_C void CDir::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

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.
aDir	On return, a pointer to a CDir object containing the extracted directory entries.

(generated from Symbian Developer Library)

◆ NewL()

static IMPORT_C CDir * CDir::NewL ( )

staticprotected

Allocates and constructs a directory object.

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

(generated from Symbian Developer Library)

◆ operator[]()

IMPORT_C const TEntry & CDir::operator[] ( TInt anIndex ) const

Gets an entry from the array of directory entries.

Parameters

anIndex of the desired entry within the array.

(generated from Symbian Developer Library)

◆ Sort()

IMPORT_C TInt CDir::Sort ( TUint aEntrySortKey )

Sorts the array of directory entries.

TEntryKey

Parameters

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

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ RFs

friend class RFs

friend

Definition at line 1988 of file f32file.h.

◆ TOpenFileScan

friend class TOpenFileScan

friend

Definition at line 1989 of file f32file.h.

Member Data Documentation

◆ iArray

CArrayPakFlat<TEntry>* CDir::iArray

protected

Definition at line 1987 of file f32file.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~CDir()

◆ CDir()

Member Function Documentation

◆ AddL()

◆ Compress()

◆ Count()

◆ ExtractL()

◆ NewL()

◆ operator[]()

◆ Sort()

Friends And Related Symbol Documentation

◆ RFs

◆ TOpenFileScan

Member Data Documentation

◆ iArray