FLCBYT-API
FLUC Byte Interface
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.
 

Functions

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

Detailed Description

Specification for the FLUC byte interface.

Author
limes datentechnik gmbh
Date
01.03.2016