FLCBYT-API FLUC Byte Interface

Macros | Functions
FLCBYT.h File Reference

Specification for the FLUC byte interface. More...

`#include <stddef.h>`
`#include <stdint.h>`
`#include "FLMRTC.h"`
`#include "FLMDEF.h"`

Go to the source code of this file.

## Macros
#define | fcberrno (*piFcbErrno())
| FLAM return code. More...

## Functions
const char * | fcbvsn (void)
| Retrieves version information. More...
const char * | fcbabo (void)
| Retrieves about information. More...
const char * | fcblic (void)
| Retrieves the license text. More...
int | fcbenv (const int sys, const int std, const char *env)
| Load the FLAM environment. More...
char * | fcbsym (const char *name, size_t size, char *string)
| Determines a symbol from environment. More...
int | fcbinfo (const char *infstr, const int format, size_t *bufsiz, char **buffer)
| Provides various information. More...
int | fcbopnlog (const char *logstr)
| Open the logging facility for in-memory logging. More...
int | fcbgetlog (const char **buffer)
| Get log information. More...
int | fcbclrlog (void)
| Clear the log information. More...
int | fcbclslog (void)
| Close the logging facility. More...
void * | fcbopen (const char *filstr, const char *fmtstr)
| Open file (without state management) More...
void * | fcbopen2 (const char *filstr, const char *fmtstr, char **state)
| Open file (with state management) More...
int | fcbclose (void *hdl)
| Close file (without statistics) More...
int | fcbclose2 (void *hdl, const int success, const int stafmt, size_t *stasiz, char **stabuf)
| Close file with return of statistics information. More...
const char * | fcbgtn (void *hdl)
| Returns the current table name. More...
const char * | fcbgfn (void *hdl, const int ind)
| Returns the current file name. More...
const char * | fcbstn (void *hdl, const char *name)
| Sets the current table format. More...
int | fcbflush (void *hdl)
| Flush internal buffers to the file. More...
void * | fcbnewmbr (void *hdl, const char *fmtstr, const char *state)
| Start with a new member in an open file. More...
void * | fcbnewmbr2 (void *hdl, const char *fmtstr, const char *state, const int stafmt, size_t *stasiz, char **stabuf)
| Start with a new member in a open file (with statistics information) More...
void * | fcbopenv (void *hdl, const char *cnvstr)
| Open converter. More...
int | fcbclosev (void *cnv)
| Close a converter. More...
size_t | fcbread (void *ptr, size_t size, size_t count, void *hdl)
| Read file data. More...
size_t | fcbreadv (void *ptr, size_t size, size_t count, void *hdl, void *cnv, const int skip)
| Read file data with conversion. More...
size_t | fcbwrite (const void *ptr, size_t size, size_t count, void *hdl)
| Write data to file. More...
size_t | fcbwritev (const void *ptr, size_t size, size_t count, void *hdl, void *cnv)
| Write data to file with conversion. More...
int | fcbprev (void *hdl)
| Sets the read position to the previous record or element. More...
int | fcbgetc (void *hdl)
| Gets the next character. More...
int | fcbungetc (int chr, void *hdl)
| Push a character back back to the stream. More...
int | fcbputc (int chr, void *hdl)
| Writes a character. More...
char * | fcbgets (char *str, int n, void *hdl)
| Reads a line. More...
int | fcbputs (const char *str, void *hdl)
| Writes a null-terminated string. More...
int | fcbconv (void *cnv, size_t inplen, const void *inp, size_t *outlen, void *out)
| Converts independent data blocks (with copy) More...
int | fcbconp (void *cnv, size_t inplen, const void *inp, size_t *outlen, void **out)
| Converts independent data blocks (with locate) More...
int | fcbrunv (void *cnv, size_t inplen, const void *inp, size_t *outlen, void *out)
| Converts dependent data blocks (with copy) More...
int | fcbrunp (void *cnv, size_t inplen, const void *inp, size_t *outlen, void **out)
| Converts dependent data blocks (with locate) More...
int | fcbfinv (void *cnv, size_t inplen, const void *inp, size_t *outlen, void *out)
| Finish conversion of dependent data blocks (with copy) More...
int | fcbfinp (void *cnv, size_t inplen, const void *inp, size_t *outlen, void **out)
| Finish conversion of dependent data blocks (with locate) More...
int | fcbeof (void *hdl)
| Returns the end-of-file (EOF) flag. More...
int | fcbeot (void *hdl)
| Returns the end-of-table (EOT) flag. More...
int | fcberror (void *hdl)
| Get error code. More...
const char * | fcberrms (int code)
| Get error message. More...
const char * | fcberrtr (void)
| Get error trace. More...
void | fcbclearerr (void *hdl)
| Clear error and EOF indicators. More...
const char * | fcbhelp (const int what, const int depth, const char *path)
| Returns help information about the file and format strings. More...
const char * | fcbsyntax (const int what, const int depth, const char *path)
| Returns syntax information about the file and format strings. More...
const char * | fcbcheck (const int what, const char *string)
| Check syntax for a certain CLP string. More...
long long int | fcbcount (void *hdl, const int direction, const int what, const int kind)
| Determine current amount of processed data. More...
void * | fcbbini (const unsigned int mode, const unsigned int base, const unsigned int chrs)
| Creates a handle for Base16/32/64 encoding or decoding. More...
int | fcbbrun (void *hdl, const int inlen, const unsigned char *in, unsigned char *out)
| En- or Decodes a data buffer. More...
int | fcbbfin (void *hdl, const int inlen, const unsigned char *in, unsigned char *out)
| Finalize en- or decoding. More...
int | fcbbase (const unsigned int mode, const unsigned int base, const unsigned int chrs, const int inlen, const unsigned char *in, unsigned char *out)
| Base encoding or decoding for one message. More...
void * | fcbhini (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. More...
int | fcbhadd (void *hdl, const unsigned int datlen, const unsigned char *dat)
| Adds a buffer of data to the hash calculation. More...
int | fcbhfin (void *hdl, unsigned int *hshlen, unsigned char *hsh)
| Finalize hash calculation. More...
int | fcbhash (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 a single buffer. More...

## Detailed Description

Specification for the FLUC byte interface.

Author
  limes datentechnik gmbh

Date
  01.03.2016

Copyright
  (c) 2016 limes datentechnik gmbh