FLCREC-API FLUC Record Interface

FLCRECLB.h
Go to the documentation of this file.
1
619#ifdef __cplusplus
620 extern "C" {
621#endif
622
623#ifndef INC_FLCRECLB_H
624#define INC_FLCRECLB_H
627#include "FLMRTC.h"
628#include "FLMDEF.h"
629
630 /*********************************************************************/
633#ifndef MF_SUPPORT
634# define FCR_READ_FILE FLC_READ_FILE
635# define FCR_READ_FORMAT FLC_READ_FORMAT
636# define FCR_WRITE_FILE FLC_WRITE_FILE
637# define FCR_WRITE_FORMAT FLC_WRITE_FORMAT
638# define FCR_CONV_READ FLC_CONV_READ
639# define FCR_CONV_WRITE FLC_CONV_WRITE
640# define FCR_INPUT_FILE FLC_INPUT_FILE
641# define FCR_OUTPUT_FILE FLC_OUTPUT_FILE
642# define FCR_INFO FLC_INFO
643# define FCR_STATE FLC_STATE
644# define FCR_LOG FLC_LOG
645#endif
646
647#ifdef MF_SUPPORT
648# define PFIX(n) _mf_ ## n
649# define FCRVSN PFIX(FCRVSN)
650# define FCRABO PFIX(FCRABO)
651# define FCRLIC PFIX(FCRLIC)
652# define FCRHLP PFIX(FCRHLP)
653# define FCRSYN PFIX(FCRSYN)
654# define FCRMSG PFIX(FCRMSG)
655# define FCRTRC PFIX(FCRTRC)
656# define FCRINF PFIX(FCRINF)
657# define FCROPN PFIX(FCROPN)
658# define FCRNEWM PFIX(FCRNEWM)
659# define FCROPNV PFIX(FCROPNV)
660# define FCRPUT PFIX(FCRPUT)
661# define FCRPUTV PFIX(FCRPUTV)
662# define FCRCNT PFIX(FCRCNT)
663# define FCRFLU PFIX(FCRFLU)
664# define FCRGET PFIX(FCRGET)
665# define FCRGETV PFIX(FCRGETV)
666# define FCRLOC PFIX(FCRLOC)
667# define FCRLOCV PFIX(FCRLOCV)
668# define FCRPRV PFIX(FCRPRV)
669# define FCRCONV PFIX(FCRCONV)
670# define FCRRUNV PFIX(FCRRUNV)
671# define FCRFINV PFIX(FCRFINV)
672# define FCRCONP PFIX(FCRCONP)
673# define FCRRUNP PFIX(FCRRUNP)
674# define FCRFINP PFIX(FCRFINP)
675# define FCRCLS PFIX(FCRCLS)
676# define FCRCLSV PFIX(FCRCLSV)
677# define FCRCLR PFIX(FCRCLR)
678# define FCRGFN PFIX(FCRGFN)
679# define FCRGTN PFIX(FCRGTN)
680# define FCRSTN PFIX(FCRSTN)
681# define FCRENV PFIX(FCRENV)
682# define FCRSYM PFIX(FCRSYM)
683# define FCROPNL PFIX(FCROPNL)
684# define FCRGETL PFIX(FCRGETL)
685# define FCRCPYL PFIX(FCRCPYL)
686# define FCRCLRL PFIX(FCRCLRL)
687# define FCRCLSL PFIX(FCRCLSL)
688# define FCRCPY PFIX(FCRCPY)
689# define FCRPTR PFIX(FCRPTR)
690# define FCRHASH PFIX(FCRHASH)
691# define FCRHINI PFIX(FCRHINI)
692# define FCRHADD PFIX(FCRHADD)
693# define FCRHFIN PFIX(FCRHFIN)
694# define FCRBASE PFIX(FCRBASE)
695# define FCRBINI PFIX(FCRBINI)
696# define FCRBRUN PFIX(FCRBRUN)
697# define FCRBFIN PFIX(FCRBFIN)
698#endif
699#ifdef USE_MF_SUPPORT
700# define FCRVSN fcrvsn
701# define FCRABO fcrabo
702# define FCRLIC fcrlic
703# define FCRHLP fcrhlp
704# define FCRSYN fcrsyn
705# define FCRMSG fcrmsg
706# define FCRTRC fcrtrc
707# define FCRINF fcrinf
708# define FCROPN fcropn
709# define FCRNEWM fcrnewm
710# define FCROPNV fcropnv
711# define FCRPUT fcrput
712# define FCRPUTV fcrputv
713# define FCRFLU fcrflu
714# define FCRCNT fcrcnt
715# define FCRGET fcrget
716# define FCRGETV fcrgetv
717# define FCRLOC fcrloc
718# define FCRLOCV fcrlocv
719# define FCRPRV fcrprv
720# define FCRCONV fcrconv
721# define FCRRUNV fcrrunv
722# define FCRFINV fcrfinv
723# define FCRCONP fcrconp
724# define FCRRUNP fcrrunp
725# define FCRFINP fcrfinp
726# define FCRCLS fcrcls
727# define FCRCLSV fcrclsv
728# define FCRCLR fcrclr
729# define FCRGFN fcrgfn
730# define FCRGTN fcrgtn
731# define FCRSTN fcrstn
732# define FCRENV fcrenv
733# define FCRSYM fcrsym
734# define FCROPNL fcropnl
735# define FCRGETL fcrgetl
736# define FCRCPYL fcrcpyl
737# define FCRCLRL fcrclrl
738# define FCRCLSL fcrclsl
739# define FCRCPY fcrcpy
740# define FCRPTR fcrptr
741# define FCRHASH fcrhash
742# define FCRHINI fcrhini
743# define FCRHADD fcrhadd
744# define FCRHFIN fcrhfin
745# define FCRBASE fcrbase
746# define FCRBINI fcrbini
747# define FCRBRUN fcrbrun
748# define FCRBFIN fcrbfin
749#endif
751/**********************************************************************/
767 extern void FCRVSN(
768 int* rtc,
769 int* vsnLen,
770 char* vsn);
771
783 extern void FCRABO(
784 int* rtc,
785 int* aboLen,
786 char* abo);
787
798 extern void FCRLIC(
799 int* rtc,
800 int* licLen,
801 char* lic);
802
834 extern void FCRHLP(
835 int* rtc,
836 const int* what,
837 const int* depth,
838 const int* pathLen,
839 const char* path,
840 int* outLen,
841 char* out);
842
874 extern void FCRSYN(
875 int* rtc,
876 const int* what,
877 const int* depth,
878 const int* pathLen,
879 const char* path,
880 int* outLen,
881 char* out);
882
915 extern void FCRMSG(
916 int* rtc,
917 const int* code,
918 int* msgLen,
919 char* msg);
920
935 extern void FCRTRC(
936 int* rtc,
937 const int* code,
938 int* trcLen,
939 char* trc);
940
951 extern void FCRCLR(void** hdl);
952
986 extern void FCRENV(int* rtc, const int* sys, const int* std, const int* envLen, const char* envStr, int* cnt);
987
1004 extern void FCRSYM(int* rtc, const int* inpLen, const char* inpStr, int* outLen, char* outStr);
1005
1035 extern void FCROPNL(int* rtc,const int* strLen, const char* logStr);
1036
1050 extern void FCRGETL(int* maxCod, int* bufLen, const char** buffer);
1051
1066 extern void FCRCPYL(int* maxCod, int* bufLen, char* buffer);
1067
1075 extern void FCRCLRL(int* maxCod);
1076
1085 extern void FCRCLSL(int* maxCod);
1086
1130 extern void FCRINF(
1131 int* rtc,
1132 const int* infoLen,
1133 const char* infoStr,
1134 const int* format,
1135 int* buflen,
1136 char* buffer);
1137
1290 extern void FCROPN(
1291 void** hdl,
1292 int* rtc,
1293 const int* fileLen,
1294 const char* fileStr,
1295 const int* formatLen,
1296 const char* formatStr,
1297 int* stateLen,
1298 char* stateStr);
1299
1375 extern void FCROPNV(
1376 void** hdl,
1377 void** cnv,
1378 int* rtc,
1379 const int* convLen,
1380 const char* convStr);
1381
1412 extern void FCRNEWM(
1413 void** hdl,
1414 int* rtc,
1415 const int* formatLen,
1416 const char* formatStr,
1417 const int* stateLen,
1418 const char* stateStr,
1419 const int* format,
1420 int* buflen,
1421 char* buffer);
1422
1423
1480 extern void FCRPUT(
1481 void** hdl,
1482 int* rtc,
1483 const int* recLen,
1484 const char* rec);
1485
1508 extern void FCRPUTV(
1509 void** hdl,
1510 int* rtc,
1511 const int* recLen,
1512 const char* rec,
1513 void** cnv);
1514
1536 extern void FCRGTN(
1537 void** hdl,
1538 int* rtc,
1539 int* length,
1540 char* name);
1541
1565 extern void FCRGFN(
1566 void** hdl,
1567 int* rtc,
1568 const int ind,
1569 int* length,
1570 char* name);
1571
1596 extern void FCRSTN(
1597 void** hdl,
1598 int* rtc,
1599 const int* length,
1600 const char* name);
1601
1617 extern void FCRFLU(
1618 void** hdl,
1619 int* rtc);
1620
1719 extern void FCRGET(
1720 void** hdl,
1721 int* rtc,
1722 int* recLen,
1723 char* rec);
1724
1759 extern void FCRGETV(
1760 void** hdl,
1761 int* rtc,
1762 int* recLen,
1763 char* rec,
1764 void** cnv,
1765 int* skip);
1766
1797 extern void FCRLOC(
1798 void** hdl,
1799 int* rtc,
1800 int* recLen,
1801 char** rec);
1802
1833 extern void FCRLOCV(
1834 void** hdl,
1835 int* rtc,
1836 int* recLen,
1837 char** rec,
1838 void** cnv,
1839 int* skip);
1840
1862 extern void FCRPRV(
1863 void** hdl,
1864 int* rtc);
1865
1866
1951 extern void FCRCONV(
1952 void** cnv,
1953 int* rtc,
1954 const int* inpLen,
1955 const char* inp,
1956 int* outLen,
1957 char* out);
1958
1974 extern void FCRCONP(
1975 void** cnv,
1976 int* rtc,
1977 const int* inpLen,
1978 const char* inp,
1979 int* outLen,
1980 char** out);
1981
2020 extern void FCRRUNV(
2021 void** cnv,
2022 int* rtc,
2023 const int* inpLen,
2024 const char* inp,
2025 int* outLen,
2026 char* out);
2027
2043 extern void FCRRUNP(
2044 void** cnv,
2045 int* rtc,
2046 const int* inpLen,
2047 const char* inp,
2048 int* outLen,
2049 char** out);
2050
2081 extern void FCRFINV(
2082 void** cnv,
2083 int* rtc,
2084 const int* inpLen,
2085 const char* inp,
2086 int* outLen,
2087 char* out);
2088
2104 extern void FCRFINP(
2105 void** cnv,
2106 int* rtc,
2107 const int* inpLen,
2108 const char* inp,
2109 int* outLen,
2110 char** out);
2111
2175 extern void FCRCLS(
2176 void** hdl,
2177 int* rtc,
2178 const int* success,
2179 const int* format,
2180 int* buflen,
2181 char* buffer);
2182
2197 extern void FCRCLSV(
2198 void** cnv,
2199 int* rtc);
2200
2221 extern void FCRCPY(
2222 const int* len,
2223 const char* ptr,
2224 char* dat);
2225
2243 extern void FCRPTR(
2244 const char* dat,
2245 const char** ptr);
2246
2279 extern void FCRCNT(
2280 void** hdl,
2281 int* rtc,
2282 const int* dir,
2283 const int* wht,
2284 const int* knd,
2285 long long int* val);
2286
2316 extern int FCRBINI(
2317 void** hdl,
2318 const unsigned int* mode,
2319 const unsigned int* base,
2320 const unsigned int* chrs);
2321
2342 extern int FCRBRUN(
2343 void** hdl,
2344 const unsigned int* datlen,
2345 const unsigned char* dat,
2346 unsigned char* out);
2347
2368 extern int FCRBFIN(
2369 void** hdl,
2370 const unsigned int* datlen,
2371 const unsigned char* dat,
2372 unsigned char* out);
2373
2395 extern int FCRBASE(
2396 const unsigned int* mode,
2397 const unsigned int* base,
2398 const unsigned int* chrs,
2399 const unsigned int* datlen,
2400 const unsigned char* dat,
2401 unsigned char* out);
2402
2437 extern int FCRHINI(
2438 void** hdl,
2439 const unsigned int* hmtd,
2440 const unsigned int* kmtd,
2441 const unsigned int* keylen,
2442 const unsigned char* key,
2443 const unsigned int* icvlen,
2444 const unsigned char* icv);
2445
2463 extern int FCRHADD(
2464 void** hdl,
2465 const unsigned int* datlen,
2466 const unsigned char* dat);
2467
2489 extern int FCRHFIN(
2490 void** hdl,
2491 unsigned int* hshlen,
2492 unsigned char* hsh);
2493
2522 extern int FCRHASH(
2523 const unsigned int* hmtd,
2524 const unsigned int* kmtd,
2525 const unsigned int* keylen,
2526 const unsigned char* key,
2527 const unsigned int* icvlen,
2528 const unsigned char* icv,
2529 const unsigned int* datlen,
2530 const unsigned char* dat,
2531 unsigned int* hshlen,
2532 unsigned char* hsh);
2533
2535/**********************************************************************/
2536
2538#endif /* INC_FLCRECLB_H */
2539
2540#ifdef __cplusplus
2541 }
2542#endif
FLMDEF.h
FLMDEF - External FLAM definitions.
FLMRTC.h
FLMRTC - FLAM-Return-Codes.
FCRSTN
void FCRSTN(void **hdl, int *rtc, const int *length, const char *name)
Set table name.
FCRCONP
void FCRCONP(void **cnv, int *rtc, const int *inpLen, const char *inp, int *outLen, char **out)
Converts element data (with locate)
FCROPN
void FCROPN(void **hdl, int *rtc, const int *fileLen, const char *fileStr, const int *formatLen, const char *formatStr, int *stateLen, char *stateStr)
Opens a file.
FCRGTN
void FCRGTN(void **hdl, int *rtc, int *length, char *name)
Get table name.
FCRBINI
int FCRBINI(void **hdl, const unsigned int *mode, const unsigned int *base, const unsigned int *chrs)
Initialize base encoding or decoding.
FCRVSN
void FCRVSN(int *rtc, int *vsnLen, char *vsn)
Retrieves the version string.
FCRGETV
void FCRGETV(void **hdl, int *rtc, int *recLen, char *rec, void **cnv, int *skip)
Reads one element with conversion.
FCRFLU
void FCRFLU(void **hdl, int *rtc)
Flush internal buffers.
FCRHADD
int FCRHADD(void **hdl, const unsigned int *datlen, const unsigned char *dat)
Add a junk of data to the hash calculation buffer.
FCRPRV
void FCRPRV(void **hdl, int *rtc)
Sets the read position to the previous record or element.
FCRNEWM
void FCRNEWM(void **hdl, int *rtc, const int *formatLen, const char *formatStr, const int *stateLen, const char *stateStr, const int *format, int *buflen, char *buffer)
Start with a new member in an open file.
FCRCLS
void FCRCLS(void **hdl, int *rtc, const int *success, const int *format, int *buflen, char *buffer)
Closes a file.
FCRCLSV
void FCRCLSV(void **cnv, int *rtc)
Closes a converter.
FCROPNL
void FCROPNL(int *rtc, const int *strLen, const char *logStr)
Open global facility for memory logging.
FCRFINP
void FCRFINP(void **cnv, int *rtc, const int *inpLen, const char *inp, int *outLen, char **out)
Finish conversion of dependent data blocks (with locate)
FCRCLR
void FCRCLR(void **hdl)
Clear error information.
FCRCLRL
void FCRCLRL(int *maxCod)
Clear the log information.
FCRCPYL
void FCRCPYL(int *maxCod, int *bufLen, char *buffer)
Copies log information to a provided buffer.
FCRLOC
void FCRLOC(void **hdl, int *rtc, int *recLen, char **rec)
Locates one record or element (without own buffer)
FCRABO
void FCRABO(int *rtc, int *aboLen, char *abo)
Retrieves the about string.
FCRHFIN
int FCRHFIN(void **hdl, unsigned int *hshlen, unsigned char *hsh)
Finalize hash calculation.
FCRHLP
void FCRHLP(int *rtc, const int *what, const int *depth, const int *pathLen, const char *path, int *outLen, char *out)
Returns help information about the file, format, state and info strings.
FCRCPY
void FCRCPY(const int *len, const char *ptr, char *dat)
Copy a memory area (MF-EDZ pointer handling workaround)
FCRFINV
void FCRFINV(void **cnv, int *rtc, const int *inpLen, const char *inp, int *outLen, char *out)
Finish conversion of dependent data blocks (with copy)
FCRCNT
void FCRCNT(void **hdl, int *rtc, const int *dir, const int *wht, const int *knd, long long int *val)
Determine current amount of processed data.
FCRINF
void FCRINF(int *rtc, const int *infoLen, const char *infoStr, const int *format, int *buflen, char *buffer)
Provides various information.
FCRSYN
void FCRSYN(int *rtc, const int *what, const int *depth, const int *pathLen, const char *path, int *outLen, char *out)
Returns syntax information about the file, format, state and info strings.
FCRMSG
void FCRMSG(int *rtc, const int *code, int *msgLen, char *msg)
Retrieves an error message.
FCRGFN
void FCRGFN(void **hdl, int *rtc, const int ind, int *length, char *name)
Get file name.
FCRBRUN
int FCRBRUN(void **hdl, const unsigned int *datlen, const unsigned char *dat, unsigned char *out)
En- or Decode a junk of data.
FCRRUNP
void FCRRUNP(void **cnv, int *rtc, const int *inpLen, const char *inp, int *outLen, char **out)
Converts dependent data blocks (with locate)
FCRSYM
void FCRSYM(int *rtc, const int *inpLen, const char *inpStr, int *outLen, char *outStr)
Determines a symbol from environment.
FCRCLSL
void FCRCLSL(int *maxCod)
Close the global logging facility.
FCRGETL
void FCRGETL(int *maxCod, int *bufLen, const char **buffer)
Get log information.
FCRPTR
void FCRPTR(const char *dat, const char **ptr)
Convert pointer to native format (MF-EDZ pointer handling workaround)
FCRPUTV
void FCRPUTV(void **hdl, int *rtc, const int *recLen, const char *rec, void **cnv)
Writes one element with conversion.
FCRBASE
int FCRBASE(const unsigned int *mode, const unsigned int *base, const unsigned int *chrs, const unsigned int *datlen, const unsigned char *dat, unsigned char *out)
Base encoding or decoding for one message.
FCRRUNV
void FCRRUNV(void **cnv, int *rtc, const int *inpLen, const char *inp, int *outLen, char *out)
Converts dependent data blocks (with copy)
FCRGET
void FCRGET(void **hdl, int *rtc, int *recLen, char *rec)
Reads one record or element.
FCRHASH
int FCRHASH(const unsigned int *hmtd, const unsigned int *kmtd, const unsigned int *keylen, const unsigned char *key, const unsigned int *icvlen, const unsigned char *icv, const unsigned int *datlen, const unsigned char *dat, unsigned int *hshlen, unsigned char *hsh)
Calculate hash for one message.
FCRLOCV
void FCRLOCV(void **hdl, int *rtc, int *recLen, char **rec, void **cnv, int *skip)
Reads one element with conversion (without own buffer)
FCRPUT
void FCRPUT(void **hdl, int *rtc, const int *recLen, const char *rec)
Writes one record or element.
FCROPNV
void FCROPNV(void **hdl, void **cnv, int *rtc, const int *convLen, const char *convStr)
Opens a converter.
FCRLIC
void FCRLIC(int *rtc, int *licLen, char *lic)
Gets the license text.
FCRBFIN
int FCRBFIN(void **hdl, const unsigned int *datlen, const unsigned char *dat, unsigned char *out)
Finalize en- or decoding.
FCRTRC
void FCRTRC(int *rtc, const int *code, int *trcLen, char *trc)
Error trace.
FCRCONV
void FCRCONV(void **cnv, int *rtc, const int *inpLen, const char *inp, int *outLen, char *out)
Converts element data (with copy)
FCRENV
void FCRENV(int *rtc, const int *sys, const int *std, const int *envLen, const char *envStr, int *cnt)
Load the FLAM environment.
FCRHINI
int FCRHINI(void **hdl, const unsigned int *hmtd, const unsigned int *kmtd, const unsigned int *keylen, const unsigned char *key, const unsigned int *icvlen, const unsigned char *icv)
Initialize hash calculation.