fs.h

SmartARM2400系列开发板全套资料

/*********************************************************************************************************
** Function name:			FileClose
** Descriptions:			关闭指定文件
** input parameters:		hHandle:   文件句柄
** output parameters:       none
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U FileClose(HANDLE hHandle);

/*********************************************************************************************************
** Function name:			FileRead
** Descriptions:			读取文件
** input parameters:		ulSize:  要读的字节数
**                          hHandle: 文件句柄
** output parameters:       vpBuf:   保存读回的数据
** Returned value:			实际读到的字节数
*********************************************************************************************************/
extern INT32U FileRead(void *pvBuf, INT32U ulSize, HANDLE hHandle);

/*********************************************************************************************************
** Function name:			FileWrite
** Descriptions:			写文件
** input parameters:		vpBuf:   保存读回的数据
**                          ulSize:  要读的字节数
**                          hHandle: 文件句柄
** output parameters:       none
** Returned value:			实际写的字节数
*********************************************************************************************************/
extern INT32U FileWrite(const void *pvBuf, INT32U ulSize, HANDLE hHandle);

/*********************************************************************************************************
** Function name:			FileCloseAll
** Descriptions:			关闭所有打开的文件
** input parameters:		none
** output parameters:       none
** Returned value:			none
*********************************************************************************************************/
extern void FileCloseAll(void);

/*********************************************************************************************************
** Function name:			FileEof
** Descriptions:			判断文件是否到读\写到文件尾
** input parameters:		hHandle: 文件句柄
** output parameters:       none
** Returned value:			0:       否
**                          1:       是
*********************************************************************************************************/
extern INT8U FileEof(HANDLE hHandle);

/*********************************************************************************************************
** Function name:			FileSeek
** Descriptions:			移动文件读\写位置
** input parameters:		hHandle:  文件句柄
**                          lOffset:  移动偏移量
**                          ucWhence: 移动模式
**                                    SEEK_SET: 从文件头计算
**                                    SEEK_CUR: 从当前位置计算
**                                    SEEK_END: 从文件尾计算
** output parameters:       none
** Returned value:			0:        否
**                          1:        是
*********************************************************************************************************/
extern INT8U FileSeek(HANDLE hHandle, INT32S lOffset, INT8U ucWhence);

/*********************************************************************************************************
** Function name:			RemoveFile
** Descriptions:			删除文件
** input parameters:		pcDirFileName: 用户使用的文件名
** output parameters:       none
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U RemoveFile(const char *pcDirFileName);

/*********************************************************************************************************
** Function name:			RenameFile
** Descriptions:			文件改名
** input parameters:		pcOldName: 旧文件名
**                          pcNewName: 新文件名
** output parameters:       none
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U RenameFile(const char *pcOldName, const char *pcNewName);

/*********************************************************************************************************
** Function name:			GetFileSize
** Descriptions:			获得指定文件大小
** input parameters:		cpDirFileName: 用户使用的文件名
** output parameters:       none
** Returned value:			文件大小,文件不存在返回0
*********************************************************************************************************/
extern INT32U GetFileSize(const char *pcDirFileName);

/*********************************************************************************************************
** Function name:			GetFileDataTime
** Descriptions:			获得指定文件最后写时间
** input parameters:		cpDirFileName: 用户使用的文件名
** output parameters:       dtData:        文件的修改日期
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明 
*********************************************************************************************************/
extern INT8U GetFileDataTime(DATE_TIME *pdtData, const char *pcDirFileName);

/*********************************************************************************************************
** Function name:			GetFileOffset
** Descriptions:			获得文件当前读写位置位置
** input parameters:		hHandle: 文件句柄
** output parameters:       ucErr:   RETURN_OK: 成功
**                                   其它参考本文件中关于返回值的说明
** Returned value:			文件位置(偏移量)
*********************************************************************************************************/
extern INT32U GetFileOffset(HANDLE hHandle, INT8U *pucErr);

/*********************************************************************************************************
** Function name:           TempDirOpen
** Descriptions:            打开临时目录，用于快速建立临时文件
** input parameters:        pcDirName: 用户使用的目录名
** output parameters:       none
** Returned value:          临时目录句柄，NOT_OPEN_DIR为不能打开
*********************************************************************************************************/
extern DHANDLE TempDirOpen(const char *pcDirName);

/*********************************************************************************************************
** Function name:           TempDirClose
** Descriptions:            关闭指定临时目录
** input parameters:        dhHandle:  临时目录句柄
** output parameters:       none
** Returned value:          RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U TempDirClose(HANDLE dhHandle);

/*********************************************************************************************************
** Function name:           TempFileOpen
** Descriptions:            快速建立文件，用户需要自己保证文件名的唯一性及不重复打开
**                          只能在非根目录快速建立文件
** input parameters:        cpFileName : 用户使用的文件名，不能带路径
**                          dhDhandle  : 临时目录句柄 
** output parameters:       none
** Returned value:          文件句柄，NOT_OPEN_FILE为不能打开
*********************************************************************************************************/
extern HANDLE TempFileOpen(const char *pcFileName, DHANDLE dhDhandle);

#define OpenTempFile(a, b)    TempFileOpen(a, b)                        /*  兼容老版本，将被废除        */

/*********************************************************************************************************
** Function name:			ChangeDrive
** Descriptions:			改变当前逻辑盘
** input parameters:		cpDrive:       逻辑盘符字符串
** output parameters:       none
** Returned value:			RETURN_OK:     成功
**                          NOT_FIND_DISK: 逻辑盘不存在
**                          PARAMETER_ERR: 非法参数
*********************************************************************************************************/
extern INT8U ChangeDrive(const char *pcDrive);

/*********************************************************************************************************
** Function name:			ChangeDir
** Descriptions:			改变当前目录
** input parameters:		cpPath:    路径名
** output parameters:       none
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U ChangeDir(const char *pcPath);

/*********************************************************************************************************
** Function name:			MakeDir
** Descriptions:			建立目录
** input parameters:		cpPath:    路径名
** output parameters:       none
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U MakeDir(const char *pcPath);

/*********************************************************************************************************
** Function name:			RemoveDir
** Descriptions:			删除目录
** input parameters:		cpPath:    路径名
** output parameters:       none
** Returned value:			RETURN_OK: 成功
**                                     其它参考本文件中关于返回值的说明
*********************************************************************************************************/
extern INT8U RemoveDir(const char *pcPath);

/*********************************************************************************************************
** Function name:           DirCheckIsEmpty
** Descriptions:            查看指定目录是否为空
** input parameters:        pcDirName:  目录名称