BSUL::CCachedDriveInfo Class Reference

#include <bsul/ccacheddriveinfo.h>

Link against: bsul.lib

class BSUL::CCachedDriveInfo : public CBase

Inherits from

BSUL::CCachedDriveInfo

Public Member Functions
	~CCachedDriveInfo()
IMPORT_C TDriveUnit	GetDefaultRemovableMemoryCardDriveL()
IMPORT_C TBool	IsFlagSetOnDriveL(TDriveUnit, TUint)
IMPORT_C TBool	IsReadOnlyInternalL(const TDesC &)
IMPORT_C TBool	IsReadOnlyInternalL(TDriveUnit)
IMPORT_C TBool	MediaTypeL(TDriveUnit, TMediaType, TMediaType *)
IMPORT_C CCachedDriveInfo *	NewL(RFs &)
IMPORT_C CCachedDriveInfo *	NewLC(RFs &)

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

Detailed Description

Class used to cache F32 drive information.

See also: TDriveInfo

Constructor & Destructor Documentation

~CCachedDriveInfo ( )

IMPORT_C

~CCachedDriveInfo

(

)

Frees all allocated resources

Member Function Documentation

GetDefaultRemovableMemoryCardDriveL ( )

IMPORT_C TDriveUnit

GetDefaultRemovableMemoryCardDriveL

(

)

const

This method fetches the default removable memory card (MMC card). To determine the MMC drive a default algorithm will be used.

The algorithm to be used will be to search through the drive list provided by RFs for the first drive that has the following properties 1) Drive type is EMediaHardDisk 2) Drive attributes are KDriveAttRemovable and KDriveAttLocal

See also: TDriveInfo

leave: KErrNotFound if drive not found

Returns: TDriveUnit The drive found by the algorithm

IsFlagSetOnDriveL ( TDriveUnit, TUint )

IMPORT_C TBool	IsFlagSetOnDriveL	(	TDriveUnit	aDrive,
			TUint	aFlags
		)	const

This method allows the caller to test the attributes of a drive to see if they are set. For example, a drive can be check whether it is remote by checking the flag KDriveAttRemote is set. Valid flags are those defined in e32const.h starting KDriveAtt*

See also: TDriveInfo

leave: KErrBadName if aDrive is not a valid drive between EDriveA and EDriveZ

Parameter	Description
aDrive	The drive whose attribute information is being tested
aFlags	The attributes to be checked for the drive

Returns: ETrue if attributes in the drive are set, EFalse otherwise

IsReadOnlyInternalL ( const TDesC & )

IMPORT_C TBool

IsReadOnlyInternalL

(

const TDesC &

aFullName

)

const

Checks if the drive associated with aFullName is both read-only and internal by checking that the KMediaAttWriteProtected and KDriveAttInternal flags are both set.

leave: Leaves with a system-wide error code if the aFullName cannot be parsed, or with KErrBadName if the supplied path does not contain a drive letter

Parameter	Description
aFullName	File name that includes a drive

Returns: Returns ETrue if the drive is read-only and internal, EFalse otherwise (including when the drive is not mounted)

IsReadOnlyInternalL ( TDriveUnit )

IMPORT_C TBool

IsReadOnlyInternalL

(

TDriveUnit

aDrive

)

const

Checks if the specified drive is both read-only and internal by checking that the KMediaAttWriteProtected and KDriveAttInternal flags are both set.

leave: Leaves with KErrBadName if aDrive is not a valid drive between EDriveA and EDriveZ

Parameter	Description
aDrive	The drive whose read-only status is being retrieved

Returns: Returns ETrue if the drive is read-only and internal, EFalse otherwise (including when the drive is not mounted)

MediaTypeL ( TDriveUnit, TMediaType, TMediaType * )

IMPORT_C TBool	MediaTypeL	(	TDriveUnit	aDrive,
			TMediaType	aTestValue,
			TMediaType *	aActual = NULL
		)	const

This method allows the caller to check the media type of a drive, to see if a drive is of a particular media type. It also optionally returns the media type of the drive.

See also: TDriveInfo

leave: KErrBadName if aDrive is not a valid drive between EDriveA and EDriveZ

Parameter	Description
aDrive	The drive whose media type information is being checked.
aTestValue	The media type to compare against the drive provided.
aActual	return parameter - if the caller provides a pointer for this parameter type, then it will be populated with the actual media type of the drive. This is useful to avoid repeated queries if the media type is needed.

Returns: ETrue if the drive media type matches the media type provided