FLMREC.h

Go to the documentation of this file.

 
#ifndef INC_FLMREC_H
#define INC_FLMREC_H

#ifdef __cplusplus
   extern "C" {
#endif
 
#include "FLMRTC.h"
#include "FLMDEF.h"
 
/**********************************************************************/
#define FMR_READ_ARC     FLM_DECO_ARCHIVE 
#define FMR_DECO_ARC     FLM_DECO_ARCHIVE 
#define FMR_READ_FORMAT  FLC_READ_FORMAT  
#define FMR_WRITE_ARC    FLM_COMP_ARCHIVE 
#define FMR_COMP_ARC     FLM_COMP_ARCHIVE 
#define FMR_WRITE_FORMAT FLC_WRITE_FORMAT 
#define FMR_STATE        FLC_STATE        
#define FMR_LOG          FLC_LOG          
 
/**********************************************************************/

typedef struct FmrMbrSta {
   long long  siRecCnt;  
   long long  siSegCnt;  
   long long  siElmCnt;  
   long long  siOrgLen;  
   long long  siCmpLen;  
} TsFmrMbrSta;

typedef struct FmrChkResult {
   int siTotal;    
   int siSuccess;  
   int siErrors;   
   int siReason;   
} TsFmrChkResult;

 
/**********************************************************************/

extern int siFmrVersion(const int siSize, char* pcBuffer);

extern int siFmrAbout(const int siSize, char* pcBuffer);

extern int siFmrLicense(const int siSize, char* pcBuffer);

extern int siFmrHelp(
   char*       pcErr,
   const int   siWhat,
   const int   siDepth,
   const char* pcPath,
   int*        piOut,
   char**      ppOut);

extern int siFmrSyntax(
   char*       pcErr,
   const int   siWhat,
   const int   siDepth,
   const char* pcPath,
   int*        piOut,
   char**      ppOut);

extern int siFmrCheck(
   char*       pcErr,
   const int   siWhat,
   const char* pcString,
   int*        piOut,
   char**      ppOut);

extern int siFmrOpen(
   char*       pcErr,
   void**      ppGbl,
   const int   isSys,
   const int   isStd,
   const char* pcEnv,
   const char* pcLog);

extern int siFmrClose(void* pvGbl);

extern int siFmrGetLog(void* pvGbl, const char** ppLog);

extern int siFmrClearLog(void* pvGbl);

extern void vdFmrDeactivateLog(void* pvGbl);

extern void vdFmrReactivateLog(void* pvGbl);

extern int siFmrOpenArchive(
   char*       pcErr,
   void*       pvGbl,
   void**      ppHdl,
   const char* pcArchive,
   const char* pcFormat,
   const int   siNumber);

extern int siFmrNextMember(
   char*       pcErr,
   void*       pvHdl,
   const char* pcFormat);

extern int siFmrLocate(
   char*                   pcErr,
   void*                   pvHdl,
   int*                    piLen,
   const unsigned char**   ppRec,
   const int               siSkip,
   void*                   pvCnv);

extern int siFmrGet(
   char*          pcErr,
   void*          pvHdl,
   int*           piLen,
   unsigned char* pcRec,
   const int      siSkip,
   void*          pvCnv);

extern int siFmrNewMember(
   char*       pcErr,
   void*       pvHdl,
   const char* pcFormat,
   const int   siStaFmt,
   int*        piStaSiz,
   char**      ppStaBuf);

extern int siFmrPut(
   char*                pcErr,
   void*                pvHdl,
   const int            siLen,
   const unsigned char* pcRec,
   void*                pvCnv);

extern int siFmrFlush(
   char*     pcErr,
   void*     pvHdl,
   const int isFinal,
   const int isForce);

extern const char* pcFmrGetArcName(void* pvHdl);

extern const char* pcFmrGetMbrName(void* pvHdl);

extern const char* pcFmrGetTabName(void* pvHdl);

extern const char* pcFmrGetMbrState(void* pvHdl, const int isCurrent);

extern const char* pcFmrGetArcComment(void* pvHdl);

extern const unsigned char* pcFmrGetArcHeader(void* pvHdl, unsigned int* puiLen);

extern unsigned int uiFmrGetArcType(void* pvHdl);

extern unsigned int uiFmrGetArcMbrCount(void* pvHdl);

extern unsigned int uiFmrGetArcVersion(void* pvHdl);

extern unsigned int uiFmrGetArcSaveMode(void* pvHdl);

extern const char* pcFmrGetFtrName(void* pvHdl);

extern const char* pcFmrGetMbrComment(void* pvHdl);

extern const unsigned char* pcFmrGetMbrHeader(void* pvHdl, unsigned int* puiLen);

extern int siFmrSetArcComment(
   char*       pcErr,
   void*       pvHdl,
   const char* pcCmt);

extern int siFmrSetMbrComment(
   char*       pcErr,
   void*       pvHdl,
   const char* pcCmt);

extern int siFmrSetArcHeader(
   char*                pcErr,
   void*                pvHdl,
   const unsigned char* pcHdr,
   unsigned int         uiLen);

extern int siFmrSetMbrHeader(
   char*                pcErr,
   void*                pvHdl,
   const unsigned char* pcHdr,
   unsigned int         uiLen);

extern int siFmrSetTabName(
   char*       pcErr,
   void*       pvHdl,
   const char* pcName);

extern int siFmrSetMbrName(
   char*       pcErr,
   void*       pvHdl,
   const char* pcName);

extern int siFmrSetMbrState(
   char*       pcErr,
   void*       pvHdl,
   const char* pcState);

extern int siFmrCloseArchive(
   char*     pcErr,
   void*     pvHdl,
   const int isSuccess,
   const int siStaFmt,
   int*      piStaSiz,
   char**    ppStaBuf);

extern const char* pcFmrGetArcInfo(
   void*        pvHdl,
   char*        pcBuf,
   unsigned int uiSiz);

extern int siFmrCheckArchive(
   char*           pcErr,
   void*           pvHdl,
   const int       siLev,
   TsFmrChkResult* psResult);

extern int siFmrGetMbrStatistics(void* pvHdl, TsFmrMbrSta* psSta);

extern const char* pcFmrErrorMessage(const int siRtc);

/**********************************************************************/

 
//TODO(5.2.2): required function for modify (free access)
//    extern int siFmrOpenMbr(char* pcErr, void* pvHdl, void** ppHdl, const void* pvEnt, char** ppState);
//TODO(5.2.2): siFmrOpenTab()
//       extern int siFmrFnd(char* pcErr, void* pvHdl, const int siLen, const unsigned char* pcRec);//red/upd(key)
//       extern int siFmrAdd(char* pcErr, void* pvHdl, const int siLen, const unsigned char* pcRec);//add/wrt
//       extern int siFmrIns(char* pcErr, void* pvHdl, const int siLen, const unsigned char* pcRec);//upd(key)
//       extern int siFmrUpd(char* pcErr, void* pvHdl, const int siLen, const unsigned char* pcRec);//upd(key)
//       extern int siFmrDel(char* pcErr, void* pvHdl, const int siLen, const unsigned char* pcRec);//upd
//TODO(5.2.2): siFmrCloseTab()
//    extern int siFmrCloseMbr(char* pcErr, void* pvHdl);
 
//TODO(5.2.2): required function for fuse
//    extern int siFmrArcWlk(char* pcErr, void* pvHdl, const int siOri, void** ppEnt);//red
//    extern int siFmrArcMch(char* pcErr, void* pvHdl, void* pvEnt);//red
 
#ifdef __cplusplus
   }
#endif
#endif /* INC_FLMREC_H */