FLMRECLB - FLAM5 archive record interface for COBOL and PL/1. More...

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

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.

Functions
void	FMRVSN (int piRtc, int piSize, char *pcBuffer)
	Returns version information.
void	FMRABO (int piRtc, int piSize, char *pcBuffer)
	Returns about information.
void	FMRLIC (int piRtc, int piSize, char *pcBuffer)
	Returns the license text.
void	FMRHLP (int piRtc, char pcErr, const int piWhat, const int piDepth, const int piPathLen, const char pcPath, int piOutLen, char pcOut)
	Retrieves help text for an archive or format string parameter.
void	FMRSYN (int piRtc, char pcErr, const int piWhat, const int piDepth, const int piPathLen, const char pcPath, int piOutLen, char pcOut)
	Retrieves syntax information for an archive or format string.
void	FMRCHK (int piRtc, char pcErr, const int piWhat, const int piStrLen, const char pcString, int piOutLen, char *pcOut)
	Validates an archive or format string.
void	FMROPN (int piRtc, char pcErr, void *ppGbl, const int piSys, const int piStd, const int piEnvLen, const char pcEnv, const int piLogLen, const char *pcLog)
	Opens a global session with optional in-memory logging.
void	FMRCLS (int piRtc, void *ppGbl)
	Closes a global session.
void	FMRGLG (int piRtc, void ppGbl, int piMaxCod, int piLogLen, char pcLog)
	Retrieves in-memory log messages.
void	FMRCLG (int piRtc, void *ppGbl)
	Clears the in-memory log buffer.
void	FMRDLG (int piRtc, void *ppGbl)
	Deactivates in-memory logging.
void	FMRRLG (int piRtc, void *ppGbl)
	Reactivates in-memory logging.
void	FMROPA (int piRtc, char pcErr, void ppGbl, void ppHdl, const int piArcLen, const char pcArchive, const int piFmtLen, const char pcFormat, const int *piNumber)
	Opens a FLAM5 archive for read or write access.
void	FMRNXM (int piRtc, char pcErr, void *ppHdl, const int piFmtLen, const char *pcFormat)
	Advances to the next matching member (read mode).
void	FMRLOC (int piRtc, char pcErr, void *ppHdl, int piLen, const unsigned char *ppRec, const int piSkip, void **ppCnv)
	Locates the next record without copying (zero-copy read).
void	FMRGET (int piRtc, char pcErr, void *ppHdl, int piLen, unsigned char pcRec, const int piSkip, void **ppCnv)
	Reads the next record into a caller-supplied buffer (read mode).
void	FMRNWM (int piRtc, char pcErr, void *ppHdl, const int piFmtLen, const char pcFormat, const int piStaFmt, int piStaLen, char pcStaBuf)
	Starts a new member in an open archive (write mode).
void	FMRPUT (int piRtc, char pcErr, void *ppHdl, const int piLen, const unsigned char pcRec, void *ppCnv)
	Writes a record or element to the current member (write mode).
void	FMRFLU (int piRtc, char pcErr, void *ppHdl, const int piFinal, const int *piForce)
	Flushes buffered records to the archive (write mode).
void	FMRCLA (int piRtc, char pcErr, void *ppHdl, const int piSuccess, const int piStaFmt, int piStaLen, char *pcStaBuf)
	Closes a FLAM5 archive and releases all resources.
void	FMRGAN (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the current archive file name.
void	FMRGMN (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the name of the current archive member.
void	FMRGTN (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the current table name.
void	FMRGMS (int piRtc, void ppHdl, const int piCurrent, int piLen, char pcBuf)
	Returns the member state string.
void	FMRSTN (int piRtc, char pcErr, void *ppHdl, const int piNameLen, const char *pcName)
	Sets the current table name (write mode).
void	FMRSMN (int piRtc, char pcErr, void *ppHdl, const int piNameLen, const char *pcName)
	Sets the current member name (write mode).
void	FMRSMS (int piRtc, char pcErr, void *ppHdl, const int piStateLen, const char *pcState)
	Sets member state attributes (write mode).
void	FMRMSG (int piRtc, const int piCode, int piLen, char pcBuf)
	Maps a FLAM return code to a short English message.
void	FMRGAC (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the archive comment string.
void	FMRGAH (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the binary user header from the archive.
void	FMRGAT (int piRtc, void ppHdl, int piVal)
	Returns the archive type identifier.
void	FMRGMC (int piRtc, void ppHdl, int piVal)
	Returns the number of members in the archive.
void	FMRGMM (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the user comment of the last read member.
void	FMRGMH (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the binary user header of the last read member.
void	FMRGAV (int piRtc, void ppHdl, int piVal)
	Returns the archive format version.
void	FMRGSM (int piRtc, void ppHdl, int piVal)
	Returns the archive save mode.
void	FMRGFN (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns the filter name for the current member (DECO path).
void	FMRSAC (int piRtc, char pcErr, void *ppHdl, const int piCmtLen, const char *pcCmt)
	Sets the archive comment (write mode).
void	FMRSMC (int piRtc, char pcErr, void *ppHdl, const int piCmtLen, const char *pcCmt)
	Sets the member comment (write mode).
void	FMRSAH (int piRtc, char pcErr, void *ppHdl, const int piLen, const unsigned char *pcHdr)
	Sets the archive-level binary user header (write mode).
void	FMRSMH (int piRtc, char pcErr, void *ppHdl, const int piLen, const unsigned char *pcHdr)
	Sets the member-level binary user header (write mode).
void	FMRGAI (int piRtc, void ppHdl, int piLen, char *pcBuf)
	Returns a human-readable description of the open archive.
void	FMRCAI (int piRtc, char pcErr, void *ppHdl, int piLev, int piTotal, int piSuccess, int piErrors, int piReason)
	Performs an integrity check on the open archive.
void	FMRGMT (int piRtc, void ppHdl, long long psiRecCnt, long long psiSegCnt, long long psiElmCnt, long long psiOrgLen, long long psiCmpLen)
	Returns member statistics for the currently open member.

Detailed Description

FLMRECLB - FLAM5 archive record interface for COBOL and PL/1.

Author: limes datentechnik gmbh

Date: 04.03.2026

Copyright: limes datentechnik (R) gmbh

Macro Definition Documentation

◆ FMR_READ_ARC

#define FMR_READ_ARC FLM_DECO_ARCHIVE

DECO archive string (FROM/READ); alias: FMR_DECO_ARC.

◆ FMR_DECO_ARC

#define FMR_DECO_ARC FLM_DECO_ARCHIVE

DECO archive string (FROM/READ); alias: FMR_READ_ARC.

◆ FMR_READ_FORMAT

#define FMR_READ_FORMAT FLC_READ_FORMAT

Format string in read/DECO mode.

◆ FMR_WRITE_ARC

#define FMR_WRITE_ARC FLM_COMP_ARCHIVE

COMP archive string (TO/WRITE); alias: FMR_COMP_ARC.

◆ FMR_COMP_ARC

#define FMR_COMP_ARC FLM_COMP_ARCHIVE

COMP archive string (TO/WRITE); alias: FMR_WRITE_ARC.

◆ FMR_WRITE_FORMAT

#define FMR_WRITE_FORMAT FLC_WRITE_FORMAT

Format string in write/COMP mode.

◆ FMR_STATE

#define FMR_STATE FLC_STATE

State string (member metadata).

◆ FMR_LOG

#define FMR_LOG FLC_LOG

Memory log string.

Macros

Functions