Symbian^3 Application Developer Library >

RLocalDrive Class Reference

class RLocalDrive : public RBusLogicalChannel

Interface class to local media

Inherits from

Public Member Functions
TInt Caps ( TDes8 &)
TInt Clear (const TDesC8 &)
TInt Connect ( TInt , TBool &)
TInt ControlIO ( TInt , TAny *, TAny *)
TInt ControlIO ( TInt , TDes8 &, TInt )
TInt ControlIO ( TInt , TDesC8 &, TInt )
TInt ControlIO ( TInt , TInt , TInt )
TInt DeleteNotify ( TInt64 , TInt )
TInt Enlarge ( TInt )
TInt ErasePassword ()
TInt ForceMediaChange ( TInt )
TInt Format ( TInt64 , TInt )
TInt GetLastErrorInfo ( TDesC8 &)
TInt IsRemovable ( TInt &)
TMediaDevice MediaDevice ()
void NotifyChange ( TRequestStatus *)
void NotifyChangeCancel ()
TInt PasswordStoreLengthInBytes ()
TInt QueryDevice ( TQueryDevice , TDes8 &)
TInt Read ( TInt64 , TInt , const TAny *, TInt , TInt , TInt )
TInt Read ( TInt64 , TInt , const TAny *, TInt , TInt )
TInt Read ( TInt64 , TInt , TDes8 &)
TInt ReadPasswordData ( TDesC8 &)
TInt Reduce ( TInt , TInt )
TInt SetMountInfo (const TDesC8 *, TInt )
TInt SetPassword (const TDesC8 &, const TDesC8 &, TBool )
TInt Unlock (const TDesC8 &, TBool )
TVersion VersionRequired ()
TInt Write ( TInt64 , TInt , const TAny *, TInt , TInt , TInt )
TInt Write ( TInt64 , TInt , const TAny *, TInt , TInt )
TInt Write ( TInt64 , const TDesC8 &)
TInt WritePasswordData (const TDesC8 &)
Inherited Functions
RBusLogicalChannel::DoCancel(TUint)
RBusLogicalChannel::DoControl(TInt)
RBusLogicalChannel::DoControl(TInt,TAny *)
RBusLogicalChannel::DoControl(TInt,TAny *,TAny *)
RBusLogicalChannel::DoCreate(const TDesC &,const TVersion &,TInt,const TDesC *,const TDesC8 *,TOwnerType,TBool)
RBusLogicalChannel::DoRequest(TInt,TRequestStatus &)
RBusLogicalChannel::DoRequest(TInt,TRequestStatus &,TAny *)
RBusLogicalChannel::DoRequest(TInt,TRequestStatus &,TAny *,TAny *)
RBusLogicalChannel::DoSvControl(TInt)
RBusLogicalChannel::DoSvControl(TInt,TAny *)
RBusLogicalChannel::DoSvControl(TInt,TAny *,TAny *)
RBusLogicalChannel::Open(RMessagePtr2,TInt,TOwnerType)
RBusLogicalChannel::Open(TInt,TOwnerType)
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RHandleBase::SetReturnedHandle(TInt)
RHandleBase::SetReturnedHandle(TInt,RHandleBase &)
Public Member Enumerations
enum TControl {
EControlRead  = 0, EControlWrite  = 1, EControlCaps  = 2, EControlFormat  = 3, EControlEnlarge  = 4, EControlReduce  = 5, EControlForceMediaChange  = 6, EControlMediaDevice  = 7, EControlPasswordLock  = 8, EControlPasswordUnlock  = 9, EControlPasswordClear  = 10, EControlNotifyChange  = 11, EControlNotifyChangeCancel  = 12, EControlReadPasswordStore  = 13, EControlWritePasswordStore  = 14, EControlPasswordStoreLengthInBytes  = 15, EControlIsRemovable  = 16, EControlSetMountInfo  = 17, EControlControlIO  = 18, EControlPasswordErase  = 19, EControlDeleteNotify  = 20, EControlGetLastErrorInfo  = 21, EControlQueryDevice  = 22
}
enum TQueryDevice {
EQuerySymbianPublishedPartnerFirst  = 0x0000, EQuerySymbianPublishedPartnerLast  = 0x3FFF, EQuerySymbianTestFirst  = 0x4000, EQuerySymbianTestLast  = 0x7FFF, EQueryLicenseeFirst  = 0x8000, EQueryLicenseeLast  = 0xBFFF, EQueryPageDeviceInfo  = EQuerySymbianTestFirst
}
enum TReadWriteFlags { ELocDrvMetaData  = 0x80000000, ELocDrvWholeMedia  = 0x40000000 }
enum TRemountFlags { ELocDrvRemountNotifyChange  = 0, ELocDrvRemountForceMediaChange  = 1 }
Inherited Enumerations
RHandleBase:TAttributes
Inherited Attributes
RHandleBase::iHandle

Member Functions Documentation

Caps(TDes8 &)

TInt Caps ( TDes8 & anInfo ) [inline]

Parameters

TDes8 & anInfo

Clear(const TDesC8 &)

TInt Clear ( const TDesC8 & aPassword ) [inline]

Parameters

const TDesC8 & aPassword

Connect(TInt, TBool &)

TInt Connect ( TInt aDriveNumber,
TBool & aChangedFlag
) [inline]
capability
TCB

Parameters

TInt aDriveNumber
TBool & aChangedFlag

ControlIO(TInt, TAny *, TAny *)

TInt ControlIO ( TInt aCommand,
TAny * aParam1,
TAny * aParam2
) [inline]

Parameters

TInt aCommand
TAny * aParam1
TAny * aParam2

ControlIO(TInt, TDes8 &, TInt)

TInt ControlIO ( TInt aCommand,
TDes8 & aBuf,
TInt aParam
) [inline]

Parameters

TInt aCommand
TDes8 & aBuf
TInt aParam

ControlIO(TInt, TDesC8 &, TInt)

TInt ControlIO ( TInt aCommand,
TDesC8 & aBuf,
TInt aParam
) [inline]

Parameters

TInt aCommand
TDesC8 & aBuf
TInt aParam

ControlIO(TInt, TInt, TInt)

TInt ControlIO ( TInt aCommand,
TInt aParam1,
TInt aParam2
) [inline]

Parameters

TInt aCommand
TInt aParam1
TInt aParam2

DeleteNotify(TInt64, TInt)

TInt DeleteNotify ( TInt64 aPos,
TInt aLength
) [inline]

Parameters

TInt64 aPos
TInt aLength

Enlarge(TInt)

TInt Enlarge ( TInt aLength ) [inline]

Parameters

TInt aLength

ErasePassword()

TInt ErasePassword ( ) [inline]

ForceMediaChange(TInt)

TInt ForceMediaChange ( TInt aMode = 0 ) [inline]

Parameters

TInt aMode = 0

Format(TInt64, TInt)

TInt Format ( TInt64 aPos,
TInt aLength
) [inline]

Parameters

TInt64 aPos
TInt aLength

GetLastErrorInfo(TDesC8 &)

TInt GetLastErrorInfo ( TDesC8 & aErrorInfo ) [inline]

Parameters

TDesC8 & aErrorInfo

IsRemovable(TInt &)

TInt IsRemovable ( TInt & aSocketNum ) [inline]

Parameters

TInt & aSocketNum

MediaDevice()

TMediaDevice MediaDevice ( ) [inline]

NotifyChange(TRequestStatus *)

void NotifyChange ( TRequestStatus * aStatus ) [inline]

Parameters

TRequestStatus * aStatus

NotifyChangeCancel()

void NotifyChangeCancel ( ) [inline]

PasswordStoreLengthInBytes()

TInt PasswordStoreLengthInBytes ( ) [inline]

QueryDevice(TQueryDevice, TDes8 &)

TInt QueryDevice ( TQueryDevice aQueryDevice,
TDes8 & aBuf
) [inline]

Parameters

TQueryDevice aQueryDevice
TDes8 & aBuf

Read(TInt64, TInt, const TAny *, TInt, TInt, TInt)

TInt Read ( TInt64 aPos,
TInt aLength,
const TAny * aTrg,
TInt aMessageHandle,
TInt aOffset,
TInt aFlags
) [inline]

Parameters

TInt64 aPos
TInt aLength
const TAny * aTrg
TInt aMessageHandle
TInt aOffset
TInt aFlags

Read(TInt64, TInt, const TAny *, TInt, TInt)

TInt Read ( TInt64 aPos,
TInt aLength,
const TAny * aTrg,
TInt aMessageHandle,
TInt anOffset
) [inline]

Parameters

TInt64 aPos
TInt aLength
const TAny * aTrg
TInt aMessageHandle
TInt anOffset

Read(TInt64, TInt, TDes8 &)

TInt Read ( TInt64 aPos,
TInt aLength,
TDes8 & aTrg
) [inline]

Parameters

TInt64 aPos
TInt aLength
TDes8 & aTrg

ReadPasswordData(TDesC8 &)

TInt ReadPasswordData ( TDesC8 & aStoreData ) [inline]

Parameters

TDesC8 & aStoreData

Reduce(TInt, TInt)

TInt Reduce ( TInt aPos,
TInt aLength
) [inline]

Parameters

TInt aPos
TInt aLength

SetMountInfo(const TDesC8 *, TInt)

TInt SetMountInfo ( const TDesC8 * aInfo,
TInt aMessageHandle
) [inline]

Parameters

const TDesC8 * aInfo
TInt aMessageHandle

SetPassword(const TDesC8 &, const TDesC8 &, TBool)

TInt SetPassword ( const TDesC8 & aOldPassword,
const TDesC8 & aNewPassword,
TBool aStorePassword
) [inline]

Parameters

const TDesC8 & aOldPassword
const TDesC8 & aNewPassword
TBool aStorePassword

Unlock(const TDesC8 &, TBool)

TInt Unlock ( const TDesC8 & aPassword,
TBool aStorePassword
) [inline]

Parameters

const TDesC8 & aPassword
TBool aStorePassword

VersionRequired()

TVersion VersionRequired ( ) const [inline]

Write(TInt64, TInt, const TAny *, TInt, TInt, TInt)

TInt Write ( TInt64 aPos,
TInt aLength,
const TAny * aSrc,
TInt aMessageHandle,
TInt aOffset,
TInt aFlags
) [inline]

Parameters

TInt64 aPos
TInt aLength
const TAny * aSrc
TInt aMessageHandle
TInt aOffset
TInt aFlags

Write(TInt64, TInt, const TAny *, TInt, TInt)

TInt Write ( TInt64 aPos,
TInt aLength,
const TAny * aSrc,
TInt aMessageHandle,
TInt anOffset
) [inline]

Parameters

TInt64 aPos
TInt aLength
const TAny * aSrc
TInt aMessageHandle
TInt anOffset

Write(TInt64, const TDesC8 &)

TInt Write ( TInt64 aPos,
const TDesC8 & aSrc
) [inline]

Parameters

TInt64 aPos
const TDesC8 & aSrc

WritePasswordData(const TDesC8 &)

TInt WritePasswordData ( const TDesC8 & aStoreData ) [inline]

Parameters

const TDesC8 & aStoreData

Member Enumerations Documentation

Enum TControl

Enumerators

EControlRead = 0

Read request

EControlWrite = 1

Write request

EControlCaps = 2

Caps request

EControlFormat = 3

Format request

EControlEnlarge = 4

Enlarge drive request

EControlReduce = 5

Reduce Drive request

EControlForceMediaChange = 6

Force media change request

EControlMediaDevice = 7

Return the media device request

EControlPasswordLock = 8

Password lock media request

EControlPasswordUnlock = 9

Password unlock media request

EControlPasswordClear = 10

Password clear request

EControlNotifyChange = 11

Notify change request

EControlNotifyChangeCancel = 12

Notify change cancel request

EControlReadPasswordStore = 13

Read password request

EControlWritePasswordStore = 14

Write password request

EControlPasswordStoreLengthInBytes = 15

Password request

EControlIsRemovable = 16

Query removable request

EControlSetMountInfo = 17

Set mount info request

EControlControlIO = 18

Control IO request

EControlPasswordErase = 19

Password erase media request

EControlDeleteNotify = 20

Delete notification

EControlGetLastErrorInfo = 21

Get last error info request

EControlQueryDevice = 22

Query device request

Enum TQueryDevice

Enumerators

EQuerySymbianPublishedPartnerFirst = 0x0000
EQuerySymbianPublishedPartnerLast = 0x3FFF
EQuerySymbianTestFirst = 0x4000
EQuerySymbianTestLast = 0x7FFF
EQueryLicenseeFirst = 0x8000
EQueryLicenseeLast = 0xBFFF
EQueryPageDeviceInfo = EQuerySymbianTestFirst

TPageDeviceInfo

Enum TReadWriteFlags

Enumerators

ELocDrvMetaData = 0x80000000

Set if read/write request is for metadata

ELocDrvWholeMedia = 0x40000000

Set to access whole media, rather than partition

Enum TRemountFlags

Enumerators

ELocDrvRemountNotifyChange = 0

Notify clients of media change but don't remount

ELocDrvRemountForceMediaChange = 1

Notify clients of media change and remount

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.