CRsfwMountMan Class Reference

#include <mw/rsfwmountman.h>

Link against: mountman.dll

class CRsfwMountMan : public CBase

Inherits from

  • CRsfwMountMan
    Public Member Functions
    virtual ~CRsfwMountMan()
    IMPORT_C voidAddMountEntryL(CRsfwMountEntry *)
    IMPORT_C TIntCancelRemoteTransfer(const TDesC &)
    IMPORT_C voidDeleteMountEntryL(const TDesC &)
    IMPORT_C voidDeleteMountEntryL(TChar)
    IMPORT_C voidEditMountEntryL(CRsfwMountEntry *)
    IMPORT_C TIntGetAllDrivesL(TDriveList &)
    IMPORT_C TIntGetMountInfo(TChar, TRsfwMountInfo &)
    IMPORT_C voidGetMountNamesL(CDesC16Array *)
    IMPORT_C TIntGetRemoteMountListL(TDriveList &)
    IMPORT_C TBoolIsAppOnBlackList(TUid)
    IMPORT_C const CRsfwMountEntry *MountEntryL(const TDesC &)
    IMPORT_C const CRsfwMountEntry *MountEntryL(TChar)
    IMPORT_C CRsfwMountMan *NewL(TUint, MRsfwMountManObserver *)
    IMPORT_C TIntRefreshDirectory(const TDesC &)
    IMPORT_C TIntSetMountConnectionState(TChar, TUint)
    IMPORT_C TIntSetMountConnectionStateBlind(TChar, TUint)
    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 for managing mounts to remote file repositories

    Since
    Series 60 3.1

    Constructor & Destructor Documentation

    ~CRsfwMountMan ( )

    IMPORT_C~CRsfwMountMan()[virtual]

    Destructor.

    Member Function Documentation

    AddMountEntryL ( CRsfwMountEntry * )

    IMPORT_C voidAddMountEntryL(CRsfwMountEntry *aMountEntry)

    Adds a mount configuration entry in the configurations and mounts the drive in the File Server. If the drive letter item is not set in the configuration, a free letter will be allocated. Then the EMountEntryItemDrive value in aMountEntry will be changed. The EMountEntryItemIndex item of aMountEntry is used for positioning the entry in a specific order in the configuration database (the index itself is not stored)

    leave
    KErrInUse selected drive letter already in used
    leave
    KErrInUse selected name is in use
    leave
    KErrInUse 9 remote drives already define (Number of remote drives is limited by default to 9 so that drive letters are also available for other technologies)
    leave
    KErrAccessDenied program does not have sufficient capabilities required capabilities are DiskAdmin (to mount new remote drive in File Server) and WriteDeviceData (to add new remote drive to Central Repository)
    leave
    KErrNotFound File System plug-in, Central Repository table etc. not found
    ParameterDescription
    aMountEntrymount configuration entry the ownership of the pointer is transferred to CRsfwMountMan

    Returns: nothing

    CancelRemoteTransfer ( const TDesC & )

    IMPORT_C TIntCancelRemoteTransfer(const TDesC &aFile)

    Cancels an active remote file upload or download

    ParameterDescription
    aFilefile name

    Returns: one of the system wide error codes.

    DeleteMountEntryL ( const TDesC & )

    IMPORT_C voidDeleteMountEntryL(const TDesC &aName)

    Deletes a mount entry from the configurations and unmounts the drive. Nothing is done if the entry does not exist.

    ParameterDescription
    aNamename

    Returns: nothing

    DeleteMountEntryL ( TChar )

    IMPORT_C voidDeleteMountEntryL(TCharaDriveLetter)

    Deletes a mount entry from the configurations and unmounts the drive. Nothing is done if the entry does not exist.

    ParameterDescription
    aDriveLetterdrive letter

    Returns: nothing

    EditMountEntryL ( CRsfwMountEntry * )

    IMPORT_C voidEditMountEntryL(CRsfwMountEntry *aMountEntry)

    Changes a mount configuration entry in the configurations

    leave
    KErrInUse if the name of the mount is used by other mount
    leave
    KErrAccessDenied program does not have sufficient capabilities required capabilities are DiskAdmin (to mount new remote drive in File Server) and WriteDeviceData (to add new remote drive to Central Repository)
    leave
    KErrNotFound if mount with given letter not found or File System plug-in, Central Repository table etc. not found
    ParameterDescription
    aMountEntrymount configuration entry the ownership of the pointer is transferred to CRsfwMountMan

    Returns: nothing

    GetAllDrivesL ( TDriveList & )

    IMPORT_C TIntGetAllDrivesL(TDriveList &aDriveList)const

    Gets a list of all drives as seen by the File Server

    Returns drive letters. Letters for local drives are in the front of the list Letters for remote drives in order defined in CenRep The number of the drives is the same as the length of the list

    ParameterDescription
    aDriveListreturned drive list

    Returns: number of remote drives

    GetMountInfo ( TChar, TRsfwMountInfo & )

    IMPORT_C TIntGetMountInfo(TCharaDriveLetter,
    TRsfwMountInfo &aMountInfo
    )const

    Gets mount information for an active remote drive.

    The information consists of static configuration information and status information (such as strongly or weakly connected). Note that if the drive is not atctive this function will return -1, you need to use MountEntryL to get just the static configuration information

    ParameterDescription
    aDriveLetterdrive letter of the mount
    aMountInforeturned information

    Returns: error code

    GetMountNamesL ( CDesC16Array * )

    IMPORT_C voidGetMountNamesL(CDesC16Array *aNames)const

    Returns a list of friendly names of all mount configurations in the mount configuration repository. The entries are returned in the order that they appear in the repository.

    ParameterDescription
    aNamesfriendly names

    Returns: nothing

    GetRemoteMountListL ( TDriveList & )

    IMPORT_C TIntGetRemoteMountListL(TDriveList &aDriveList)const

    Gets a list of all remote drives as seen by the File Server

    The list contains the letters of the remote drives. Letters for remote drives in order defined in CenRep The number of the drives is the same as the length of the list

    ParameterDescription
    aDriveListreturned drive list

    Returns: number of remote drives

    IsAppOnBlackList ( TUid )

    IMPORT_C TBoolIsAppOnBlackList(TUidaUid)const

    Some applications have problems with handling remote files. Function checks whether app with given UID is one of them.

    ParameterDescription
    aUidUID of the application

    Returns: ETrue if it is on the black list, otherwise EFalse

    MountEntryL ( const TDesC & )

    IMPORT_C const CRsfwMountEntry *MountEntryL(const TDesC &aName)const

    Gets the mount configuration entry having the given friendly name. The caller must make sure that the name is unique.

    Returns: a pointer to the configuration entry or NULL if not found

    MountEntryL ( TChar )

    IMPORT_C const CRsfwMountEntry *MountEntryL(TCharaDriveLetter)const

    Gets the mount configuration entry for the given drive letter.

    ParameterDescription
    aDriveLetterdrive letter

    Returns: a pointer to the configuration entry or NULL if not found

    NewL ( TUint, MRsfwMountManObserver * )

    IMPORT_C CRsfwMountMan *NewL(TUintaDefaultFlags,
    MRsfwMountManObserver *aMountManObserver
    )[static]

    Two-phased constructor.

    ParameterDescription
    aDefaultFlagsmust be set to KMountFlagInteractive if the user is to be prompted during the mount procedure. Otherwise the parameter can be set to zero.

    Returns: pointer to the created CRsfwMountMan object instance

    RefreshDirectory ( const TDesC & )

    IMPORT_C TIntRefreshDirectory(const TDesC &aPath)

    Refresh a remote directory

    Ensures that contents of a remote directory are up to date. Synchronous variant deletes the currently cached version. Note that this function intentionally does not return directory contents. All data should be read through the File Server instead.

    Returns: KErrArgument Path refers to a file KErrNotFound path is not found from cache

    SetMountConnectionState ( TChar, TUint )

    IMPORT_C TIntSetMountConnectionState(TCharaDriveLetter,
    TUintaConnectionState
    )

    Sets the connection state of a mount for an active remote drive

    ParameterDescription
    aDriveLetterdrive letter of the mount
    aConnectionStateThe following connection states have been defined: KMountStronglyConnected = strongly connected state KMountWeaklyConnected = weakly connected state KMountNotConnected = disconnected state

    Returns: error code

    SetMountConnectionStateBlind ( TChar, TUint )

    IMPORT_C TIntSetMountConnectionStateBlind(TCharaDriveLetter,
    TUintaConnectionState
    )

    Sets the connection state of a mount for an active remote drive sends a bling request, does not wait for reply

    ParameterDescription
    aDriveLetterdrive letter of the mount
    aConnectionStateThe following connection states have been defined: KMountStronglyConnected = strongly connected state KMountWeaklyConnected = weakly connected state KMountNotConnected = disconnected state

    Returns: error code

    © Nokia 2011.