FLMREC.h File Reference

Specification for the FLAM Record Interface. More...

#include "FLMRTC.h"
#include "FLMDEF.h"

Go to the source code of this file.

Data Structures
struct	FmrMbrSta
	Member statistics returned by siFmrGetMbrStatistics(). More...
struct	FmrChkResult
	Result structure returned by siFmrCheckArchive(). More...

Macros
#define	FMR_READ_ARC   FLM_DECO_ARCHIVE
	DECO archive string (FROM/READ); alias: FMR_DECO_ARC.
#define	FMR_DECO_ARC   FLM_DECO_ARCHIVE
	DECO archive string (FROM/READ); alias: FMR_READ_ARC.
#define	FMR_READ_FORMAT   FLC_READ_FORMAT
	Format string in read/DECO mode.
#define	FMR_WRITE_ARC   FLM_COMP_ARCHIVE
	COMP archive string (TO/WRITE); alias: FMR_COMP_ARC.
#define	FMR_COMP_ARC   FLM_COMP_ARCHIVE
	COMP archive string (TO/WRITE); alias: FMR_WRITE_ARC.
#define	FMR_WRITE_FORMAT   FLC_WRITE_FORMAT
	Format string in write/COMP mode.
#define	FMR_STATE   FLC_STATE
	State string (member metadata).
#define	FMR_LOG   FLC_LOG
	Memory log string.

Typedefs
typedef struct FmrMbrSta	TsFmrMbrSta
	Member statistics returned by siFmrGetMbrStatistics().
typedef struct FmrChkResult	TsFmrChkResult
	Result structure returned by siFmrCheckArchive().

Functions
int	siFmrVersion (const int siSize, char *pcBuffer)
	Retrieves version information.
int	siFmrAbout (const int siSize, char *pcBuffer)
	Retrieves about information.
int	siFmrLicense (const int siSize, char *pcBuffer)
	Retrieves the license text.
int	siFmrHelp (char *pcErr, const int siWhat, const int siDepth, const char *pcPath, int *piOut, char **ppOut)
	Retrieves help text for an archive or format string parameter.
int	siFmrSyntax (char *pcErr, const int siWhat, const int siDepth, const char *pcPath, int *piOut, char **ppOut)
	Retrieves syntax information for an archive or format string.
int	siFmrCheck (char *pcErr, const int siWhat, const char *pcString, int *piOut, char **ppOut)
	Validates an archive or format string.
int	siFmrOpen (char *pcErr, void **ppGbl, const int isSys, const int isStd, const char *pcEnv, const char *pcLog)
	Opens a global session with optional in-memory logging.
int	siFmrClose (void *pvGbl)
	Closes a global session.
int	siFmrGetLog (void *pvGbl, const char **ppLog)
	Retrieves in-memory log messages.
int	siFmrClearLog (void *pvGbl)
	Clears the in-memory log buffer.
void	vdFmrDeactivateLog (void *pvGbl)
	Deactivates in-memory logging.
void	vdFmrReactivateLog (void *pvGbl)
	Reactivates in-memory logging.
int	siFmrOpenArchive (char *pcErr, void *pvGbl, void **ppHdl, const char *pcArchive, const char *pcFormat, const int siNumber)
	Opens a FLAM5 archive for read or write access.
int	siFmrNextMember (char *pcErr, void *pvHdl, const char *pcFormat)
	Advances to the next matching member (read mode).
int	siFmrLocate (char *pcErr, void *pvHdl, int *piLen, const unsigned char **ppRec, const int siSkip, void *pvCnv)
	Locates the next record without copying (zero-copy read).
int	siFmrGet (char *pcErr, void *pvHdl, int *piLen, unsigned char *pcRec, const int siSkip, void *pvCnv)
	Reads the next record into a caller-supplied buffer (read mode).
int	siFmrNewMember (char *pcErr, void *pvHdl, const char *pcFormat, const int siStaFmt, int *piStaSiz, char **ppStaBuf)
	Starts a new member in an open archive (write mode).
int	siFmrPut (char *pcErr, void *pvHdl, const int siLen, const unsigned char *pcRec, void *pvCnv)
	Writes a record or element to the current member (write mode).
int	siFmrFlush (char *pcErr, void *pvHdl, const int isFinal, const int isForce)
	Flushes buffered records to the archive (write mode).
const char *	pcFmrGetArcName (void *pvHdl)
	Returns the current archive file name.
const char *	pcFmrGetMbrName (void *pvHdl)
	Returns the name of the current archive member.
const char *	pcFmrGetTabName (void *pvHdl)
	Returns the current table name.
const char *	pcFmrGetMbrState (void *pvHdl, const int isCurrent)
	Returns the member state string.
const char *	pcFmrGetArcComment (void *pvHdl)
	Returns the archive comment string.
const unsigned char *	pcFmrGetArcHeader (void *pvHdl, unsigned int *puiLen)
	Returns the binary user header from the archive.
unsigned int	uiFmrGetArcType (void *pvHdl)
	Returns the archive type identifier.
unsigned int	uiFmrGetArcMbrCount (void *pvHdl)
	Returns the number of members in the archive.
unsigned int	uiFmrGetArcVersion (void *pvHdl)
	Returns the archive format version.
unsigned int	uiFmrGetArcSaveMode (void *pvHdl)
	Returns the archive save mode.
const char *	pcFmrGetFtrName (void *pvHdl)
	Returns the filter name for the current member (DECO path).
const char *	pcFmrGetMbrComment (void *pvHdl)
	Returns the user comment of the last read member.
const unsigned char *	pcFmrGetMbrHeader (void *pvHdl, unsigned int *puiLen)
	Returns the binary user header of the last read member.
int	siFmrSetArcComment (char *pcErr, void *pvHdl, const char *pcCmt)
	Sets the archive comment (write mode).
int	siFmrSetMbrComment (char *pcErr, void *pvHdl, const char *pcCmt)
	Sets the member comment (write mode).
int	siFmrSetArcHeader (char *pcErr, void *pvHdl, const unsigned char *pcHdr, unsigned int uiLen)
	Sets the archive-level binary user header (write mode).
int	siFmrSetMbrHeader (char *pcErr, void *pvHdl, const unsigned char *pcHdr, unsigned int uiLen)
	Sets the member-level binary user header (write mode).
int	siFmrSetTabName (char *pcErr, void *pvHdl, const char *pcName)
	Sets the current table name (write mode).
int	siFmrSetMbrName (char *pcErr, void *pvHdl, const char *pcName)
	Sets the current member name (write mode).
int	siFmrSetMbrState (char *pcErr, void *pvHdl, const char *pcState)
	Sets member state attributes (write mode).
int	siFmrCloseArchive (char *pcErr, void *pvHdl, const int isSuccess, const int siStaFmt, int *piStaSiz, char **ppStaBuf)
	Closes a FLAM5 archive and releases all resources.
const char *	pcFmrGetArcInfo (void *pvHdl, char *pcBuf, unsigned int uiSiz)
	Returns a human-readable description string for an open archive.
int	siFmrCheckArchive (char *pcErr, void *pvHdl, const int siLev, TsFmrChkResult *psResult)
	Performs an integrity check on the open archive.
int	siFmrGetMbrStatistics (void *pvHdl, TsFmrMbrSta *psSta)
	Returns member statistics for the currently open member.
const char *	pcFmrErrorMessage (const int siRtc)
	Maps a FLAM return code to a short English message.

Detailed Description

Specification for the FLAM Record Interface.

Author

limes datentechnik gmbh

Date

17.11.2025

Copyright

limes datentechnik (R) gmbh