CDirScan Class Reference

class CDirScan : public CBase

Scans a directory structure.

The scan moves from directory to directory through the hierarchy, returning a list of the entries contained in each. The order in which the directories are scanned is determined by a sort key which is specified when setting up the scan. The base directory to be scanned and the entry types of interest must also be specified before performing the scan.

This class is not intended for user derivation

Inherits from

Constructor & Destructor Documentation

CDirScan(RFs &)

CDirScan(RFs &aFs)[protected]

Parameters

RFs & aFs

~CDirScan()

IMPORT_C~CDirScan()

Member Functions Documentation

AbbreviatedPath()

IMPORT_C TPtrCAbbreviatedPath()

Fs()

RFs &Fs()[private, inline]

FullPath()

IMPORT_C TPtrCFullPath()

GetDirEntriesL(CDir *&)

voidGetDirEntriesL(CDir *&aDirEntries)[private]

Parameters

CDir *& aDirEntries

NewL(RFs &)

IMPORT_C CDirScan *NewL(RFs &aFs)[static]

Parameters

RFs & aFs

NewLC(RFs &)

IMPORT_C CDirScan *NewLC(RFs &aFs)[static]

Parameters

RFs & aFs

NextL(CDir *&)

IMPORT_C voidNextL(CDir *&aDirEntries)

Parameters

CDir *& aDirEntries

ScanDownTreeL(CDir *&)

voidScanDownTreeL(CDir *&aDirEntries)[private]

Parameters

CDir *& aDirEntries

ScanUpTreeL(CDir *&)

voidScanUpTreeL(CDir *&aDirEntries)[private]

Parameters

CDir *& aDirEntries

SetScanDataL(const TDesC &, TUint, TUint, TScanDirection)

IMPORT_C voidSetScanDataL(const TDesC &aMatchName,
TUintanEntryAttMask,
TUintanEntrySortMask,
TScanDirectionaScanDir = EScanDownTree
)

Parameters

const TDesC & aMatchName
TUint anEntryAttMask
TUint anEntrySortMask
TScanDirection aScanDir = EScanDownTree

UpdateAbbreviatedPath()

voidUpdateAbbreviatedPath()[private]

Member Enumerations Documentation

Enum TScanDirection

Defines the scan direction.

Enumerators

EScanUpTree

Scan upwards from the lowest level directory in the hierarchy to the top level directory.

EScanDownTree

Scan downwards from the top level directory in the hierarchy to the bottom level directory.

Member Data Documentation

TPtrC iAbbreviatedPath

TPtrC iAbbreviatedPath[private]

TInt iAbbreviatedPathPos

TInt iAbbreviatedPathPos[private]

TUint iEntryAttMask

TUint iEntryAttMask[private]

TUint iEntrySortMask

TUint iEntrySortMask[private]

RFs *const iFs

RFs *constiFs[private]

TParse iFullPath

TParse iFullPath[private]

TScanDirection iScanDir

TScanDirection iScanDir[private]

TBool iScanning

TBool iScanning[private]

CDirStack * iStack

CDirStack *iStack[private]