userlibandfileserver/fileserver/sfsrv/cl_cli.cpp
changeset 10 36bfc973b146
parent 9 96e5fb8b040d
child 11 329ab0095843
equal deleted inserted replaced
9:96e5fb8b040d 10:36bfc973b146
   642 
   642 
   643 
   643 
   644 
   644 
   645 /**
   645 /**
   646     Gets the name of the file system mounted on the specified drive.
   646     Gets the name of the file system mounted on the specified drive.
   647 
       
   648     The function can be called before calling DismountFileSystem().
   647     The function can be called before calling DismountFileSystem().
   649 			     
   648 			     
   650     @param aName  On successful return, contains the name of the file system.
   649     @param aName  On successful return, contains the name of the file system.
   651     @param aDrive The drive for which the file system name is required.
   650     @param aDrive The drive for which the file system name is required.
       
   651 
       
   652     Note that the file system name, returned in the aName descriptor shall be threated as case-insensitive string. I.e. 
       
   653     "fileSystem" and "FILESYSTEM" mean absolutely the same. Therefore, case-insensitive string methods (like TDesC::FindF(), TDesC::CompareF())
       
   654     shall be used to deal with the names.
   652 
   655 
   653     @return KErrNone, if successful;
   656     @return KErrNone, if successful;
   654             KErrNotFound if aFileSystemName is not found, or the drive does not have a file	system mounted on it;
   657             KErrNotFound if aFileSystemName is not found, or the drive does not have a file	system mounted on it;
   655             KErrArgument, if the drive value is outside the valid range, i.e. zero to KMaxDrives-1 inclusive.
   658             KErrArgument, if the drive value is outside the valid range, i.e. zero to KMaxDrives-1 inclusive.
   656 
   659 
   673     file systems that can be recognised and mounted automatically, without user's interaction. 
   676     file systems that can be recognised and mounted automatically, without user's interaction. 
   674     If the automatic recognition and mountng some known file systems is supported on the specified drive, there 
   677     If the automatic recognition and mountng some known file systems is supported on the specified drive, there 
   675     shall be at least 2 names in the list. For example "FAT" and "exFAT". 
   678     shall be at least 2 names in the list. For example "FAT" and "exFAT". 
   676     If "automatic file system recognising" feature is not supported, the list will consist of just one name, and 
   679     If "automatic file system recognising" feature is not supported, the list will consist of just one name, and 
   677     this will be the name returned by RFs::FileSystemName() API.
   680     this will be the name returned by RFs::FileSystemName() API.
       
   681 
       
   682     Note that the file system name, returned in the aName descriptor shall be threated as case-insensitive string. I.e. 
       
   683     "fileSystem" and "FILESYSTEM" mean absolutely the same. Therefore, case-insensitive string methods (like TDesC::FindF(), TDesC::CompareF())
       
   684     shall be used to deal with the names.
   678 
   685 
   679     @param  aName           On successful return, contains the name of the file system that correspond to the aFsEnumerator value.
   686     @param  aName           On successful return, contains the name of the file system that correspond to the aFsEnumerator value.
   680     m@param aDrive          The drive number 
   687     m@param aDrive          The drive number 
   681     @param  aFsEnumerator   The supported file system enumerator. can be:
   688     @param  aFsEnumerator   The supported file system enumerator. can be:
   682                             KRootFileSystem a special value; in this case the returned name will be the same as obtained by FileSystemName()
   689                             KRootFileSystem a special value; in this case the returned name will be the same as obtained by FileSystemName()
  3739 		r, aParamInfo.iBlockSize, aParamInfo.iClusterSize, aParamInfo.iRecReadBufSize, aParamInfo.iRecWriteBufSize);
  3746 		r, aParamInfo.iBlockSize, aParamInfo.iClusterSize, aParamInfo.iRecReadBufSize, aParamInfo.iRecWriteBufSize);
  3740 	return r;
  3747 	return r;
  3741 	}
  3748 	}
  3742 
  3749 
  3743 
  3750 
       
  3751 /**
       
  3752     This function queries the sub type of the file system mounted on the specified volume. For example, 'FAT16' of the Fat file system. 
       
  3753     TFSName is recommended as the type for aName when using this function.
       
  3754 
       
  3755     NOTE: For the file systems without a sub type (e.g. ROM file system), the  the file system name is returned (For example, 'Rom').
       
  3756     Examples:
       
  3757         "FAT"   file system; the subtypes can be "fat12", "fat16" or "fat32"
       
  3758         "ROFS"  file system; the subtype will be "ROFS"
       
  3759 
       
  3760     Note also that the file system name, returned in the aName descriptor shall be threated as case-insensitive string. I.e. 
       
  3761     "fileSystem" and "FILESYSTEM" mean absolutely the same. Therefore, case-insensitive string methods (like TDesC::FindF(), TDesC::CompareF())
       
  3762     shall be used to deal with the names.
       
  3763 
       
  3764 
       
  3765     @param  aDrive  drive number, specifies which volume to query.
       
  3766     @param  aName   descriptor containing the returned sub type name or file system name.
       
  3767 
       
  3768     @return KErrNone if successful; KErrNotSuppoted if sub type is not supported; 
       
  3769 		    otherwise another system-wide error code is returned.
       
  3770 
       
  3771     @see TFSName
       
  3772 */
  3744 EFSRV_EXPORT_C TInt RFs::FileSystemSubType(TInt aDrive, TDes& aName) const
  3773 EFSRV_EXPORT_C TInt RFs::FileSystemSubType(TInt aDrive, TDes& aName) const
  3745 /**
       
  3746 This function queries the sub type of the file system mounted on the specified volume. For example, 'FAT16' 
       
  3747 of the Fat file system. 
       
  3748 
       
  3749 TFSName is recommended as the type for aName when using this function.
       
  3750 
       
  3751 NOTE: File systems without a sub type (For example, a ROM file system), the name of the file system is 
       
  3752 returned (For example, 'Rom').
       
  3753 
       
  3754 @param aDrive A drive number, specifies which volume to query.
       
  3755 @param aName A descriptor containing the returned sub type name or file system name.
       
  3756 
       
  3757 @return KErrNone if successful; KErrNotSuppoted if sub type is not supported; 
       
  3758 		otherwise another system-wide error code is returned.
       
  3759 
       
  3760 @see TFSName
       
  3761 */
       
  3762 	{
  3774 	{
  3763 	TRACEMULT3(UTF::EBorder, UTraceModuleEfsrv::EFsFileSystemSubType, MODULEUID, Handle(), aDrive, aName);
  3775 	TRACEMULT3(UTF::EBorder, UTraceModuleEfsrv::EFsFileSystemSubType, MODULEUID, Handle(), aDrive, aName);
  3764 
  3776 
  3765 	TInt r = KErrNone;
  3777 	TInt r = KErrNone;
  3766 
  3778