FLCBYT-API FLUC Byte Interface

Data Structures | Macros
FLMDEF.h File Reference

FLMDEF - External FLAM definitions. More...

Go to the source code of this file.

## Data Structures
struct | FlmElmRec0
| FLAM 5 serialized element structure (version 0) More...

## Macros
#define | FLMOUT_FORMAT_NON 0
| Default format (FLMOUT_FORMAT_LST) More...
#define | FLMOUT_FORMAT_LST 1
| Simple list of lines with each line separated by '\n' and the whole string terminated by 0x00. More...
#define | FLMOUT_FORMAT_XML 2
| As XML-formatted, null-terminated string (in local charset) with each line separated by '\n'. More...
#define | FLC_READ_FILE 1
| File definition strings in read mode. More...
#define | FLC_READ_FORMAT 2
| Format data strings in read mode. More...
#define | FLC_WRITE_FILE 3
| File definition strings in write mode. More...
#define | FLC_WRITE_FORMAT 4
| Format data strings in write mode. More...
#define | FLC_CONV_READ 5
| Data conversion strings in read mode. More...
#define | FLC_CONV_WRITE 6
| Data conversion strings in write mode. More...
#define | FLC_CONV_FROM_TO 7
| Data conversion string in from-to mode. More...
#define | FLC_INPUT_FILE 8
| File definition strings in input mode. More...
#define | FLC_OUTPUT_FILE 9
| File definition strings in output mode. More...
#define | FLC_INFO 10
| Definition of the info string. More...
#define | FLC_STATE 11
| Definition of the state string. More...
#define | FLC_LOG 12
| Definition of the memory log string. More...
#define | FLCHSH_ALGO_NON 0U
| No valid hash method. More...
#define | FLCHSH_ALGO_MD5 1U
| MD5 method. More...
#define | FLCHSH_ALGO_RMD128 2U
| RipeMd-128 method. More...
#define | FLCHSH_ALGO_RMD160 3U
| RipeMd-160 method. More...
#define | FLCHSH_ALGO_SHA1 10U
| SHA1 method. More...
#define | FLCHSH_ALGO_SHA160 10U
| SHA1 method. More...
#define | FLCHSH_ALGO_SHA224 20U
| SHA224 (SHA2 variant) method. More...
#define | FLCHSH_ALGO_SHA256 21U
| SHA256 (SHA2 variant) method. More...
#define | FLCHSH_ALGO_SHA384 22U
| SHA384 (SHA2 variant) method. More...
#define | FLCHSH_ALGO_SHA512 23U
| SHA512 (SHA2 variant) method. More...
#define | FLCHSH_ALGO_SHA3_224 30U
| SHA3-224 method. More...
#define | FLCHSH_ALGO_SHA3_256 31U
| SHA3-256 method. More...
#define | FLCHSH_ALGO_SHA3_384 32U
| SHA3-384 method. More...
#define | FLCHSH_ALGO_SHA3_512 33U
| SHA3-512 method. More...
#define | FLCHSH_ALGO_CRC08 100U
| 8 Bit CRC checksum (no crypto quality) More...
#define | FLCHSH_ALGO_CRC16 101U
| 16 Bit CRC checksum (no crypto quality) More...
#define | FLCHSH_ALGO_CRC24 102U
| 24 Bit CRC checksum (no crypto quality) More...
#define | FLCHSH_ALGO_CRC32 103U
| 32 Bit CRC checksum (no crypto quality) More...
#define | FLCHSH_ALGO_CRC32C 104U
| 32 Bit CRC checksum (no crypto quality) More...
#define | FLCHSH_ALGO_CRC40 105U
| 40 Bit CRC checksum (no crypto quality) More...
#define | FLCHSH_ALGO_CRC64 106U
| 64 Bit CRC checksum (no crypto quality) More...
#define | FLCMAC_ALGO_NON 0U
| No valid hash method. More...
#define | FLCMAC_ALGO_HMAC 1U
| HMAC conform to RFC 2104. More...
#define | FLC_INBOUND_COUNT 1
| Use input values. More...
#define | FLC_OUTBOUND_COUNT 2
| Use output values. More...
#define | FLC_FIO_COUNT 1
| Use values from File I/O. More...
#define | FLC_FMT_COUNT 2
| Use values from formatting. More...
#define | FLC_BYTE_COUNT 1
| Determine byte counts. More...
#define | FLC_UNIT_COUNT 2
| Determine unit (block or record) counts. More...
#define | FLMMAT_TYP_NON 0x00
| Unknown/undefined matrix type. More...
#define | FLMMAT_TYP_DATBLK 0x80
| Data blocks, 1 element type, no attributes. More...
#define | FLMMAT_TYP_STDREC 0x81
| Standard record, 1 element type, no attributes. More...
#define | FLMMAT_TYP_STDASAREC 0x82
| Standard record, 1 element type, with 1 byte ASA control character as attribute. More...
#define | FLMMAT_TYP_STDMCCREC 0x83
| Standard record, 1 element type, with 1 byte machine control character as attribute. More...
#define | FLMMAT_TYP_RELREC 0x84
| Relative record, 1 element type, with 8 byte integer (slot number) as attribute. More...
#define | FLMMAT_TYP_RELASAREC 0x85
| Relative record, 1 element type, with 8 byte slot number and 1 byte ASA as attribute. More...
#define | FLMMAT_TYP_RELMCCREC 0x86
| Relative record, 1 element type, with 8 byte slot number and 1 byte MCC as attribute. More...
#define | FLMMAT_TYP_TXTREC 0x87
| Text record, 1 element type, no attributes (like standard record, but text is known) More...
#define | FLMMAT_TYP_TXTDLM 0x88
| Text record with delimiter at the end, 1 element type, no attributes. More...
#define | FLMMAT_TYP_TXTRST 0x90
| Text record and rest element (suppressed trailing whitespace and original delimiter), 2 elements, no attributes. More...
#define | FLMMAT_TYP_XMLELM 0x91
| XML elements, no attributes. More...
#define | FLMMAT_TYP_TABELM 0x92
| Table elements, no attributes. More...
#define | FLMELM_NOSKIP -1
| Use this value for an element type if no skip of an element type required at read. More...
#define | FLMELM_TYPBLK_STANDARD 0
| Simple data block element type (may contain binary data) More...
#define | FLMELM_TYPREC_STANDARD 0
| Record element type for record matrix types. More...
#define | FLMELM_TYPTXT_RECORD 0
| Text element type of a TXTRST matrix. More...
#define | FLMELM_TYPTXT_REST 1
| Rest element type of a TXTRST matrix. More...
#define | FLMELM_TYPXML_DATA 0
| XML data element type. More...
#define | FLMELM_TYPXML_STARTELM 1
| Start of opening XML tag element type. More...
#define | FLMELM_TYPXML_ENDSTRTELM 2
| End of opening XML tag element type. More...
#define | FLMELM_TYPXML_ENDELM 3
| Closing XML tag element type. More...
#define | FLMELM_TYPXML_ATTNAME 4
| Attribute name element type. More...
#define | FLMELM_TYPXML_ATTRVAL 5
| Attribute value element type. More...
#define | FLMELM_TYPXML_XML 6
| XML prolog element type. More...
#define | FLMELM_TYPXML_SKIPENT 7
| General skipped entity element type. More...
#define | FLMELM_TYPXML_SKIPPARMENT 8
| Skipped parameter entity element type. More...
#define | FLMELM_TYPXML_STARTDTD 9
| Start of a DTD (Document Type Definition) element type. More...
#define | FLMELM_TYPXML_ENDDTD 10
| End of a DTD element type. More...
#define | FLMELM_TYPXML_ELMDECL 11
| DTD element type declaration element type. More...
#define | FLMELM_TYPXML_ATTLDECL 12
| DTD attribute list declaration element type. More...
#define | FLMELM_TYPXML_INTENTDECL 13
| Internal entity declaration element type. More...
#define | FLMELM_TYPXML_SYSENTDECL 14
| External entity declaration element type with system identifier. More...
#define | FLMELM_TYPXML_PUBENTDECL 15
| External entity declaration element type with public identifier. More...
#define | FLMELM_TYPXML_NOTDECLS 16
| Notation declaration element type with a system identifier. More...
#define | FLMELM_TYPXML_NOTDECLP 17
| Notation declaration element type with a public identifier. More...
#define | FLMELM_TYPXML_NOTDECLPS 18
| Notation declaration element type with a public and system identifier. More...
#define | FLMELM_TYPXML_PROCINST 19
| Processing instruction element type. More...
#define | FLMELM_TYPXML_STARTCD 20
| Start of CDATA section element type. More...
#define | FLMELM_TYPXML_ENDCD 21
| Start of CDATA section element type. More...
#define | FLMELM_TYPXML_COMMENT 22
| Comment element type. More...
#define | FLMELM_TYPXML_DEFAULT 23
| Element type for all other data in a document. More...
#define | FLMELM_TYPXML_STARTNS 24
| Start declaration name space handler. More...
#define | FLMELM_TYPXML_ENDNS 25
| End declaration name space handler. More...
#define | FLMELM_TYPTAB_NONE 0
| No element type. More...
#define | FLMELM_TYPTAB_FLAG_NULLID 0x00010000
| Flag for null indication. More...
#define | FLMELM_TYPTAB_FLAG_EMPTID 0x00020000
| Flag for empty indication. More...
#define | FLMELM_TYPTAB_BINARY 0x00000001
| Binary element type. More...
#define | FLMELM_TYPTAB_BINARY_NI (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_BINARY_EI (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID)
#define | FLMELM_TYPTAB_BINARY_EINI (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_STRING 0x00000002
| String element type. More...
#define | FLMELM_TYPTAB_STRING_NI (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_STRING_EI (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID)
#define | FLMELM_TYPTAB_STRING_EINI (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_INTEGER 0x00000003
| Integer element type. More...
#define | FLMELM_TYPTAB_INTEGER_NI (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_INTEGER_EI (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID)
#define | FLMELM_TYPTAB_INTEGER_EINI (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_FLOAT 0x00000004
| Float element type. More...
#define | FLMELM_TYPTAB_FLOAT_NI (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_FLOAT_EI (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID)
#define | FLMELM_TYPTAB_FLOAT_EINI (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define | FLMELM_TYPTAB_HEADER 0x0000000A
| Column name element type. More...
#define | FLMELMREC0_LENGTH(element)
| Macro that calculates the length of an element of type FlmElmRec0. More...
#define | FLMELMREC0_ATTRPTR(element)
| Convenience macro that calculates the correct starting address of the attribute data within FlmElmRec0::buffer. More...
#define | FLMELMREC0_DATAPTR(element)
| Convenience macro that calculates the correct starting address of the element's data payload within FlmElmRec0::buffer. More...
#define | FLMELMREC0_HASHPTR(element)
| Convenience macro that calculates the correct starting address of the hash data within FlmElmRec0::buffer. More...

## Detailed Description

FLMDEF - External FLAM definitions.

Author
  limes datentechnik gmbh

Date
  11.01.2016

Copyright
  limes datentechnik gmbh

This header contains different global defines for FLAM application programming interfaces.

## Macro Definition Documentation

## ◆ FLMELM_TYPTAB_BINARY_NI

#define FLMELM_TYPTAB_BINARY_NI (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_BINARY_EI

#define FLMELM_TYPTAB_BINARY_EI (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID)

## ◆ FLMELM_TYPTAB_BINARY_EINI

#define FLMELM_TYPTAB_BINARY_EINI (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_STRING_NI

#define FLMELM_TYPTAB_STRING_NI (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_STRING_EI

#define FLMELM_TYPTAB_STRING_EI (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID)

## ◆ FLMELM_TYPTAB_STRING_EINI

#define FLMELM_TYPTAB_STRING_EINI (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_INTEGER_NI

#define FLMELM_TYPTAB_INTEGER_NI (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_INTEGER_EI

#define FLMELM_TYPTAB_INTEGER_EI (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID)

## ◆ FLMELM_TYPTAB_INTEGER_EINI

#define FLMELM_TYPTAB_INTEGER_EINI (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_FLOAT_NI

#define FLMELM_TYPTAB_FLOAT_NI (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_NULLID)

## ◆ FLMELM_TYPTAB_FLOAT_EI

#define FLMELM_TYPTAB_FLOAT_EI (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID)

## ◆ FLMELM_TYPTAB_FLOAT_EINI

#define FLMELM_TYPTAB_FLOAT_EINI (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)