/*############################################################################# * 文件名：file.h * 功能：  實(shí)現(xiàn)了指紋相關(guān)文件的操作 * modified by  PRTsinghua@hotmail.com#############################################################################*/#if !defined FVS__FILE_HEADER__INCLUDED__#define FVS__FILE_HEADER__INCLUDED__/* 基本類(lèi)型的定義文件 */#include "fvstypes.h"/* 對(duì)象的這些接口實(shí)現(xiàn)是私有的，不必為用戶所知。使用這里提供的函數(shù)操作文件 */typedef FvsHandle_t FvsFile_t;/******************************************************************************  * 功能：創(chuàng)建一個(gè)新的文件對(duì)象，只有在創(chuàng)建之后，文件對(duì)象才能為其它函數(shù)所用。  * 參數(shù)：無(wú)  * 返回：若創(chuàng)建失敗，返回NULL；否則返回新的對(duì)象句柄。******************************************************************************/FvsFile_t FileCreate(void);/******************************************************************************  * 功能：破壞一個(gè)已經(jīng)存在的文件對(duì)象，在毀壞之后，文件對(duì)象不能再為其它函數(shù)所用。  * 參數(shù)：file  即將刪除的文件對(duì)象指針  * 返回：無(wú)返回值******************************************************************************/void FileDestroy(FvsFile_t file);/* 文件打開(kāi)函數(shù)所用的選項(xiàng) */typedef enum FvsFileOptions_t{    /* 讀打開(kāi) */    FvsFileRead   = (1<<1),    /* 寫(xiě)打開(kāi) */    FvsFileWrite  = (1<<2),    /* 創(chuàng)建打開(kāi) */    FvsFileCreate = (1<<3)} FvsFileOptions_t;/******************************************************************************  * 功能：打開(kāi)一個(gè)新的文件。一個(gè)文件可以讀打開(kāi)，寫(xiě)打開(kāi)，或者被創(chuàng)建。  * 參數(shù)：file    文件對(duì)象  *       name    待打開(kāi)文件的名字  *       flags   打開(kāi)標(biāo)志  * 返回：錯(cuò)誤編號(hào)******************************************************************************/FvsError_t FileOpen(FvsFile_t file, const FvsString_t name, 						const FvsFileOptions_t flags);/******************************************************************************  * 功能：關(guān)閉一個(gè)文件對(duì)象，文件關(guān)閉之后，文件不再可用。  * 參數(shù)：file    文件對(duì)象  * 返回：錯(cuò)誤編號(hào)******************************************************************************/FvsError_t FileClose(FvsFile_t file);/******************************************************************************  * 功能：從文件中讀數(shù)據(jù)，所讀取的字節(jié)數(shù)由length決定。讀取的數(shù)據(jù)保存于指針data。  * 參數(shù)：file    文件對(duì)象  *       data    指向存儲(chǔ)數(shù)據(jù)的數(shù)組  *       length  要讀取的字節(jié)數(shù)  * 返回：實(shí)際讀取的字節(jié)數(shù)******************************************************************************/FvsUint_t FileRead(FvsFile_t file, FvsPointer_t data, 						const FvsUint_t length);/******************************************************************************  * 功能：往文件中寫(xiě)數(shù)據(jù)，所寫(xiě)的字節(jié)數(shù)由length決定。要寫(xiě)入的數(shù)據(jù)保存于指針data。  * 參數(shù)：file    文件對(duì)象  *       data    指向存儲(chǔ)數(shù)據(jù)的數(shù)組  *       length  要寫(xiě)入的字節(jié)數(shù)  * 返回：實(shí)際寫(xiě)入的字節(jié)數(shù)******************************************************************************/FvsUint_t FileWrite(FvsFile_t file, const FvsPointer_t data, 						const FvsUint_t length);/******************************************************************************  * 功能：從文件中得到一個(gè)字節(jié)  * 參數(shù)：file    文件對(duì)象  * 返回：讀取的字節(jié)******************************************************************************/FvsByte_t FileGetByte(FvsFile_t file);/******************************************************************************  * 功能：從文件中讀取一個(gè)字  * 參數(shù)：file    文件對(duì)象  * 返回：讀取的字******************************************************************************/FvsWord_t FileGetWord(FvsFile_t file);/******************************************************************************  * 功能：測(cè)試一個(gè)文件是否打開(kāi)  * 參數(shù)：file    文件對(duì)象  * 返回：文件打開(kāi)，則返回true；否則返回false******************************************************************************/FvsBool_t FileIsOpen(const FvsFile_t file);/******************************************************************************  * 功能：測(cè)試是否到了文件結(jié)尾  * 參數(shù)：file    文件對(duì)象  * 返回：到了結(jié)尾，返回true；否則返回false******************************************************************************/FvsBool_t FileIsAtEOF(const FvsFile_t file);/******************************************************************************  * 功能：提交對(duì)文件所作的更改  * 參數(shù)：file    文件對(duì)象  * 返回：錯(cuò)誤編號(hào)******************************************************************************/FvsError_t FileCommit(FvsFile_t file);/******************************************************************************  * 功能：跳到文件的開(kāi)頭  * 參數(shù)：file    文件對(duì)象  * 返回：錯(cuò)誤編號(hào)******************************************************************************/FvsError_t FileSeekToBegin(FvsFile_t file);/******************************************************************************  * 功能：跳到文件的結(jié)尾  * 參數(shù)：file    文件對(duì)象  * 返回：錯(cuò)誤編號(hào)******************************************************************************/FvsError_t FileSeekToEnd(FvsFile_t file);/******************************************************************************  * 功能：跳到文件的指定位置  * 參數(shù)：file     文件對(duì)象  *       position 指定的文件位置  * 返回：錯(cuò)誤編號(hào)******************************************************************************/FvsError_t FileSeek(FvsFile_t file, const FvsUint_t position);/******************************************************************************  * 功能：得到當(dāng)前的文件指針位置  * 參數(shù)：file    文件對(duì)象  * 返回：當(dāng)前的指針位置******************************************************************************/FvsUint_t FileGetPosition(FvsFile_t file);#endif /* FVS__FILE_HEADER__INCLUDED__ */