FLMDEF - External FLAM definitions. More...

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

Macros
#define	FLMOUT_FORMAT_NON 0
	Default format (FLMOUT_FORMAT_LST).
#define	FLMOUT_FORMAT_LST 1
	Simple list of lines with each line separated by '\n' and the whole string terminated by 0x00.
#define	FLMOUT_FORMAT_XML 2
	As XML-formatted, null-terminated string (in local charset) with each line separated by '\n'.
#define	FLC_READ_FILE
	File definition strings in read mode.
#define	FLC_READ_FORMAT
	Format data strings in read mode.
#define	FLC_WRITE_FILE
	File definition strings in write mode.
#define	FLC_WRITE_FORMAT
	Format data strings in write mode.
#define	FLC_CONV_READ
	Data conversion strings in read mode.
#define	FLC_CONV_WRITE
	Data conversion strings in write mode.
#define	FLC_CONV_FROM_TO
	Data conversion string in from-to mode.
#define	FLC_INPUT_FILE
	File definition strings in input mode.
#define	FLC_OUTPUT_FILE
	File definition strings in output mode.
#define	FLC_INFO 1
	Definition of the info string.
#define	FLC_STATE 1
	Definition of the state string.
#define	FLC_LOG 1
	Definition of the memory log string.
#define	FLM_COMP_ARCHIVE 2
	Simple write of records into archive (COMP).
#define	FLM_DECO_ARCHIVE 2
	Simple read of records from archive (DECO).
#define	FLCHSH_ALGO_NON 0
	No valid hash method.
#define	FLCHSH_ALGO_MD5 1
	MD5 method.
#define	FLCHSH_ALGO_RMD128 2
	RipeMd-128 method.
#define	FLCHSH_ALGO_RMD160 3
	RipeMd-160 method.
#define	FLCHSH_ALGO_SHA1 10
	SHA1 method.
#define	FLCHSH_ALGO_SHA160 10
	SHA1 method.
#define	FLCHSH_ALGO_SHA224 20
	SHA224 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA256 21
	SHA256 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA384 22
	SHA384 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA512 23
	SHA512 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA3_224 30
	SHA3-224 method.
#define	FLCHSH_ALGO_SHA3_256 31
	SHA3-256 method.
#define	FLCHSH_ALGO_SHA3_384 32
	SHA3-384 method.
#define	FLCHSH_ALGO_SHA3_512 33
	SHA3-512 method.
#define	FLCHSH_ALGO_SHAKE128 34
	SHAKE-128 extendable-output function, default 32 byte, length via CUT.
#define	FLCHSH_ALGO_SHAKE256 35
	SHAKE-256 extendable-output function, default 64 byte, length via CUT.
#define	FLCHSH_ALGO_CRC08 100
	8 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC16 101
	16 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC24 102
	24 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC32 103
	32 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC32C 104
	32 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC40 105
	40 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC64 106
	64 Bit CRC checksum, JONES variant, historical (no crypto quality)
#define	FLCHSH_ALGO_CRC64XZ 107
	64 Bit CRC checksum, CRC-64/XZ (no crypto quality)
#define	FLCHSH_ALGO_CRC64ECMA 108
	64 Bit CRC checksum, CRC-64/ECMA-182 (no crypto quality)
#define	FLCHSH_ALGO_CRC32POSIX 109
	32 Bit CRC checksum as POSIX cksum(1) (no crypto quality)
#define	FLCMAC_ALGO_NON 0
	No valid hash method.
#define	FLCMAC_ALGO_HMAC 1
	HMAC conform to RFC 2104.
#define	FLC_INBOUND_COUNT
	Use input values.
#define	FLC_OUTBOUND_COUNT
	Use output values.
#define	FLC_FIO_COUNT
	Use values from File I/O.
#define	FLC_FMT_COUNT
	Use values from formatting.
#define	FLC_BYTE_COUNT
	Determine byte counts.
#define	FLC_UNIT_COUNT
	Determine unit (block or record) counts.
#define	FLMMAT_TYP_NON 0x00U
	Unknown/undefined matrix type.
#define	FLMMAT_TYP_DATBLK 0x80U
	Data blocks, 1 element type, no attributes.
#define	FLMMAT_TYP_STDREC 0x81U
	Standard record, 1 element type, no attributes (binary).
#define	FLMMAT_TYP_STDASAREC 0x82U
	Standard record, 1 element type, with 1 byte ASA control character as attribute (text).
#define	FLMMAT_TYP_STDMCCREC 0x83U
	Standard record, 1 element type, with 1 byte machine control character as attribute (text).
#define	FLMMAT_TYP_RELREC 0x84U
	Relative record, 1 element type, with 8 byte integer (slot number) as attribute (binary).
#define	FLMMAT_TYP_RELTXTREC 0x85U
	Relative record, 1 element type, with 8 byte integer (slot number) as attribute (text).
#define	FLMMAT_TYP_RELASAREC 0x86U
	Relative record, 1 element type, with 8 byte slot number and 1 byte ASA as attribute (text).
#define	FLMMAT_TYP_RELMCCREC 0x87U
	Relative record, 1 element type, with 8 byte slot number and 1 byte MCC as attribute (text).
#define	FLMMAT_TYP_TXTREC 0x88U
	Text record, 1 element type, no attributes (like standard record, but text is known).
#define	FLMMAT_TYP_TXTDLM 0x89U
	Text record with delimiter at the end, 1 element type, no attributes.
#define	FLMMAT_TYP_TXTRST 0x90U
	Text record and rest element (suppressed trailing whitespace and original delimiter), 2 elements, no attributes.
#define	FLMMAT_TYP_XMLELM 0x91U
	XML elements, no attributes.
#define	FLMMAT_TYP_TABELM 0xF0U
	Table elements, no attributes.
#define	FLMELM_NOSKIP (-1)
	Use this value for an element type if no skip of an element type required at read.
#define	FLMELM_TYPBLK_STANDARD 0
	Simple data block element type (may contain binary data).
#define	FLMELM_TYPREC_STANDARD 0
	Record element type for record matrix types.
#define	FLMELM_TYPTXT_RECORD 0
	Text element type of a TXTRST matrix.
#define	FLMELM_TYPTXT_REST 1
	Rest element type of a TXTRST matrix.
#define	FLMELM_TYPXML_DATA 0
	XML data element type.
#define	FLMELM_TYPXML_STARTELM 1
	Start of opening XML tag element type.
#define	FLMELM_TYPXML_ENDSTRTELM 2
	End of opening XML tag element type.
#define	FLMELM_TYPXML_ENDELM 3
	Closing XML tag element type.
#define	FLMELM_TYPXML_ATTNAME 4
	Attribute name element type.
#define	FLMELM_TYPXML_ATTRVAL 5
	Attribute value element type.
#define	FLMELM_TYPXML_XML 6
	XML prolog element type.
#define	FLMELM_TYPXML_SKIPENT 7
	General skipped entity element type.
#define	FLMELM_TYPXML_SKIPPARMENT 8
	Skipped parameter entity element type.
#define	FLMELM_TYPXML_STARTDTD 9
	Start of a DTD (Document Type Definition) element type.
#define	FLMELM_TYPXML_ENDDTD 10
	End of a DTD element type.
#define	FLMELM_TYPXML_ELMDECL 11
	DTD element type declaration element type.
#define	FLMELM_TYPXML_ATTLDECL 12
	DTD attribute list declaration element type.
#define	FLMELM_TYPXML_INTENTDECL 13
	Internal entity declaration element type.
#define	FLMELM_TYPXML_SYSENTDECL 14
	External entity declaration element type with system identifier.
#define	FLMELM_TYPXML_PUBENTDECL 15
	External entity declaration element type with public identifier.
#define	FLMELM_TYPXML_NOTDECLS 16
	Notation declaration element type with a system identifier.
#define	FLMELM_TYPXML_NOTDECLP 17
	Notation declaration element type with a public identifier.
#define	FLMELM_TYPXML_NOTDECLPS 18
	Notation declaration element type with a public and system identifier.
#define	FLMELM_TYPXML_PROCINST 19
	Processing instruction element type.
#define	FLMELM_TYPXML_STARTCD 20
	Start of CDATA section element type.
#define	FLMELM_TYPXML_ENDCD 21
	Start of CDATA section element type.
#define	FLMELM_TYPXML_COMMENT 22
	Comment element type.
#define	FLMELM_TYPXML_DEFAULT 23
	Element type for all other data in a document.
#define	FLMELM_TYPXML_STARTNS 24
	Start declaration name space handler.
#define	FLMELM_TYPXML_ENDNS 25
	End declaration name space handler.
#define	FLMELM_FLAG_NULLID 0x01000000U
	Flag for null indication.
#define	FLMELM_FLAG_EMPTID 0x02000000U
	Flag for empty indication.
#define	FLMELM_TYPTAB_NONE 0x00000000U
	No element type.
#define	FLMELM_TYPTAB_BINARY 0x00000001U
	Binary element type.
#define	FLMELM_TYPTAB_STRING 0x00000002U
	String element type.
#define	FLMELM_TYPTAB_INTEGER 0x00000003U
	Integer element type.
#define	FLMELM_TYPTAB_FLOAT 0x00000004U
	Float element type.
#define	FLMELM_TYPTAB_INT64 0x00000005U
	Int64 element type.
#define	FLMELM_TYPTAB_DATE 0x00000006U
	Date/timestamp element type.
#define	FLMELM_TYPTAB_DETECT 0x00000009U
	Auto-detect column type from data (type.detect()).
#define	FLMELM_TYPTAB_HEADER 0x0000000AU
	Table header element type.
#define	FLMARC_TYPE_NONE 0x00U
	No type set (uninitialized).
#define	FLMARC_TYPE_COMPLETE 0x01U
	Complete archive: all members stored in full.
#define	FLMARC_TYPE_SUBSET_SEG 0x02U
	Subset archive: delta by segment.
#define	FLMARC_TYPE_SUBSET_SIG 0x03U
	Subset archive: delta by signature.
#define	FLMARC_TYPE_SUBSET_REC 0x04U
	Subset archive: delta by record.
#define	FLMARC_TYPE_UPDATE_SEG 0x05U
	Incremental update: changed segments.
#define	FLMARC_TYPE_UPDATE_SIG 0x06U
	Incremental update: changed by signature.
#define	FLMARC_TYPE_UPDATE_REC 0x07U
	Incremental update: changed records.
#define	FLMARC_TYPE_DELETE_SEG 0x08U
	Deletion archive: removed segments.
#define	FLMARC_TYPE_DELETE_SIG 0x09U
	Deletion archive: removed by signature.
#define	FLMARC_TYPE_DELETE_REC 0x0AU
	Deletion archive: removed records.
#define	FLMARC_TYPE_UPDDEL_SEG 0x0BU
	Update+delete combined: by segment.
#define	FLMARC_TYPE_UPDDEL_SIG 0x0CU
	Update+delete combined: by signature.
#define	FLMARC_TYPE_UPDDEL_REC 0x0DU
	Update+delete combined: by record.
#define	FLMSAV_MODE_NON 0U
	No save mode set (uninitialized).
#define	FLMSAV_MODE_FIL 1U
	Single binary file.
#define	FLMSAV_MODE_CLU 2U
	Cluster or raw device.
#define	FLMSAV_MODE_RDB 3U
	Relational database (e.g. VSAM, DB2).
#define	FLMSAV_MODE_SAM 4U
	Sequential access method (tape / QSAM).
#define	FLMSAV_MODE_FOL 5U
	Folder or object store.
#define	FLMSAV_MODE_KVS 6U
	Key-value store.
#define	FLMSAV_MODE_CS3 7U
	Amazon S3 or S3-compatible cloud object store (store.cs3()).
#define	FLMSAV_MODE_CAZ 8U
	Azure Blob Storage cloud object store (store.caz()).
#define	FLMSAV_MODE_SGU 10U
	Custom segment-store SPI backend (store.seguser()).
#define	FLMSAV_MODE_OBU 11U
	Custom object-store SPI backend (store.objuser()).
#define	FLMSAV_MODE_CDA 12U
	IBM z/OS DFSMSdfp Cloud Data Access object store (store.ibmcda()).

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.

Data Structures

Macros

Detailed Description