Symbian^3 Application Developer Library >

CLocalProxyDrive Class Reference

class CLocalProxyDrive : public CProxyDrive

Local drive specific proxy drive interface. Class passes commands directly to TBusLocalDrive .

CProxyDrive

Inherits from

Public Member Functions
TInt Caps ( TDes8 &)
TInt Clear ( TMediaPassword &)
TInt ControlIO (const RMessagePtr2 &, TInt , TAny *, TAny *)
TInt DeleteNotify ( TInt64 , TInt )
TInt Dismounted ()
TInt Enlarge ( TInt )
TInt ErasePassword ()
TInt ForceRemount ( TUint )
TInt Format ( TFormatInfo &)
TInt Format ( TInt64 , TInt )
TInt GetLastErrorInfo ( TDes8 &)
TInt Initialise ()
TInt Lock ( TMediaPassword &, TMediaPassword &, TBool )
CLocalProxyDrive * New ( CMountCB *, TBusLocalDrive &)
TInt Read ( TInt64 , TInt , const TAny *, TInt , TInt , TInt )
TInt Read ( TInt64 , TInt , const TAny *, TInt , TInt )
TInt Read ( TInt64 , TInt , TDes8 &)
TInt ReduceSize ( TInt , TInt )
TInt SetMountInfo (const TDesC8 *, TInt )
TInt Unlock ( TMediaPassword &, TBool )
TInt Write ( TInt64 , TInt , const TAny *, TInt , TInt , TInt )
TInt Write ( TInt64 , TInt , const TAny *, TInt , TInt )
TInt Write ( TInt64 , const TDesC8 &)
Protected Member Functions
TInt GetInterface ( TInt , TAny *&, TAny *)
Private Member Functions
CLocalProxyDrive ( CMountCB *, TBusLocalDrive &)
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()
CProxyDrive::CProxyDrive(CMountCB *)
CProxyDrive::Finalise(TBool)
CProxyDrive::GetLocalDrive(TBusLocalDrive *&)
CProxyDrive::LocalBufferSupport()
CProxyDrive::Mount()const
CProxyDrive::SetMount(CMountCB *)
CProxyDrive::~CProxyDrive()
Inherited Enumerations
CProxyDrive:TInterfaceIds
Private Attributes
TBusLocalDrive & iLocDrv

Constructor & Destructor Documentation

CLocalProxyDrive(CMountCB *, TBusLocalDrive &)

CLocalProxyDrive ( CMountCB * aMount,
TBusLocalDrive & aLocDrv
) [private]

Parameters

CMountCB * aMount
TBusLocalDrive & aLocDrv

Member Functions Documentation

Caps(TDes8 &)

TInt Caps ( TDes8 & anInfo ) [virtual]

Get the proxy drive's capabilities information.

Derived class must provide an implementation for it.

Parameters

TDes8 & anInfo A descriptor of the connected drives capabilities.

Clear(TMediaPassword &)

TInt Clear ( TMediaPassword & aPassword ) [virtual]

Clears a password from a proxy drive - controller sets password to null.

Derived class must provide an implementation for it.

Parameters

TMediaPassword & aPassword A descriptor containing the password.

ControlIO(const RMessagePtr2 &, TInt, TAny *, TAny *)

TInt ControlIO ( const RMessagePtr2 & aMessage,
TInt aCommand,
TAny * aParam1,
TAny * aParam2
) [virtual]

Parameters

const RMessagePtr2 & aMessage
TInt aCommand
TAny * aParam1
TAny * aParam2

DeleteNotify(TInt64, TInt)

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

Parameters

TInt64 aPos
TInt aLength

Dismounted()

TInt Dismounted ( ) [virtual]

It invokes Dismounted() on the proxy drive.

Derived class must provide an implementation for it.

Enlarge(TInt)

TInt Enlarge ( TInt aLength ) [virtual]

Increase the size of the proxy drive by the specified length (in bytes).

Derived class must provide an implementation for it.

Parameters

TInt aLength The length (in bytes) of which the drive is to be increased by.

ErasePassword()

TInt ErasePassword ( ) [virtual]

Forcibly unlock a password-enabled proxy drive.

Derived class must provide an implementation for it.

ForceRemount(TUint)

TInt ForceRemount ( TUint aFlags = 0 ) [virtual]

Forces a remount on the proxy drive

Derived class must provide an implementation for it.

Parameters

TUint aFlags = 0 Flags to be passed into the driver.

Format(TFormatInfo &)

TInt Format ( TFormatInfo & anInfo ) [virtual]

Format the connected drive.

Derived class must provide an implementation for it.

Parameters

TFormatInfo & anInfo Device specific format information.

Format(TInt64, TInt)

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

Format the proxy drive.

Derived class must provide an implementation for it.

Parameters

TInt64 aPos The position of the data which is being formatted.
TInt aLength The length of the data which is being formatted.

GetInterface(TInt, TAny *&, TAny *)

TInt GetInterface ( TInt aInterfaceId,
TAny *& aInterface,
TAny * aInput
) [protected, virtual]

Return a pointer to a specified interface extension - to allow future extension of this class without breaking binary compatibility.

Parameters

TInt aInterfaceId Interface identifier of the interface to be retrieved.
TAny *& aInterface A reference to a pointer that retrieves the specified interface.
TAny * aInput An arbitrary input argument.

GetLastErrorInfo(TDes8 &)

TInt GetLastErrorInfo ( TDes8 & aErrorInfo ) [virtual]

Parameters

TDes8 & aErrorInfo

Initialise()

TInt Initialise ( ) [virtual]

Initialise the proxy drive.

Derived class must provide an implementation for it.

Lock(TMediaPassword &, TMediaPassword &, TBool)

TInt Lock ( TMediaPassword & aOldPassword,
TMediaPassword & aNewPassword,
TBool aStorePassword
) [virtual]

Locks a password-enabled proxy drive with the new password.

Derived class must provide an implementation for it.

Parameters

TMediaPassword & aOldPassword A descriptor containing the existing password.
TMediaPassword & aNewPassword A descriptor containing the new password.
TBool aStorePassword If ETrue, the password is added to the password store.

New(CMountCB *, TBusLocalDrive &)

CLocalProxyDrive * New ( CMountCB * aMount,
TBusLocalDrive & aLocDrv
) [static]

Parameters

CMountCB * aMount
TBusLocalDrive & aLocDrv

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

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

Parameters

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

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

TInt Read ( TInt64 aPos,
TInt aLength,
const TAny * aTrg,
TInt aThreadHandle,
TInt anOffset
) [virtual]

Read from the proxy drive.

Derived class must provide an implementation for it.

Parameters

TInt64 aPos The address from where the read begins.
TInt aLength The length of the read.
const TAny * aTrg A descriptor of the memory buffer from which to read.
TInt aThreadHandle The handle-number representing the drive thread.
TInt anOffset

Read(TInt64, TInt, TDes8 &)

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

Read from the proxy drive.

Derived class must provide an implementation for it.

Parameters

TInt64 aPos The address from where the read begins.
TInt aLength The length of the read.
TDes8 & aTrg A descriptor of the memory buffer from which to read.

ReduceSize(TInt, TInt)

TInt ReduceSize ( TInt aPos,
TInt aLength
) [virtual]

Reduce the size of the proxy drive by removing the specified length (in bytes) starting at the specified position.

Derived class must provide an implementation for it.

Parameters

TInt aPos The start position of area to be removed.
TInt aLength The length/size (in bytes) by which the drive is to be reduced.

SetMountInfo(const TDesC8 *, TInt)

TInt SetMountInfo ( const TDesC8 * aMountInfo,
TInt aMountInfoThreadHandle =  KCurrentThreadHandle
) [virtual]

Set the mount information on the proxy drive.

Derived class must provide an implementation for it.

Parameters

const TDesC8 * aMountInfo Information passed down to the media driver. The meaning of this information depends on the media driver.
TInt aMountInfoThreadHandle =  KCurrentThreadHandle Message thread handle number.

Unlock(TMediaPassword &, TBool)

TInt Unlock ( TMediaPassword & aPassword,
TBool aStorePassword
) [virtual]

Unlocks a password-enabled proxy drive.

Derived class must provide an implementation for it.

Parameters

TMediaPassword & aPassword A descriptor containing the existing password.
TBool aStorePassword If ETrue, the password is added to the password store.

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

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

Parameters

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

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

TInt Write ( TInt64 aPos,
TInt aLength,
const TAny * aSrc,
TInt aThreadHandle,
TInt anOffset
) [virtual]

Write to the proxy drive.

Derived class must provide an implementation for it.

Parameters

TInt64 aPos The address from where the write begins.
TInt aLength The length of the write.
const TAny * aSrc A descriptor of the memory buffer from which to write.
TInt aThreadHandle The handle-number representing the drive thread.
TInt anOffset

Write(TInt64, const TDesC8 &)

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

Write to the proxy drive.

Derived class must provide an implementation for it.

Parameters

TInt64 aPos The address from where the write begins.
const TDesC8 & aSrc A descriptor of the memory buffer from which to write.

Member Data Documentation

TBusLocalDrive & iLocDrv

TBusLocalDrive & iLocDrv [private]

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.