FL4REC-API
FLAM4 Record Interface (Windows and Linux conform with z/OS (MF-EDZ))
FL4REC.h File Reference

Specification of FLAM4 Record Interface. More...

Go to the source code of this file.

Data Structures

struct  key_element
 Defines a key element for index sequential access methods (VSAM-KSDS) More...
 
struct  key_description
 Key elements for index sequential data access. More...
 

Typedefs

typedef char C08
 8 bit character

 
typedef signed char I08
 signed 8 bit integer

 
typedef unsigned char U08
 unsigned 8 bit integer
 
typedef signed short I16
 signed 16 bit integer

 
typedef unsigned short U16
 unsigned 16 bit integer
 
typedef signed int I32
 signed 32 bit integer

 
typedef unsigned int U32
 unsigned 32 bit integer
 
typedef signed long long int I64
 signed 64 bit integer

 
typedef unsigned long long int U64
 signed 64 bit integer

 
typedef struct key_element FKE
 Defines a key element for index sequential access methods (VSAM-KSDS)
 
typedef struct key_description FKD
 Key elements for index sequential data access.
 

Enumerations

enum  flmset_parameter {
  FLMSET_SPLITMODE = 1 , FLMSET_SPLITNUMBER = 2 , FLMSET_SPLITSIZE = 3 , FLMSET_PRIMARY_SPACE = 4 ,
  FLMSET_SECONDARY_SPACE = 5 , FLMSET_VOLUME = 6 , FLMSET_UNIT = 7 , FLMSET_DATA_CLASS = 8 ,
  FLMSET_STORAGE_CLASS = 9 , FLMSET_MANAGEMENT_CLASS = 10 , FLMSET_DISPOSTION_STATUS = 11 , FLMSET_DISPOSITION_NORMAL = 12 ,
  FLMSET_DISPOSITION_ABNORMAL = 13 , FLMSET_CRYPTOMODE =2001 , FLMSET_SECUREINFO =2002
}
 The flmset_parameter enum defines constants for the flmset() function. More...
 
enum  flmget_parameter {
  FLMGET_SPLITMODE = 1 , FLMGET_SPLITNUMBER = 2 , FLMGET_SPLITSIZE = 3 , FLMGET_CRYPTOMODE =2001 ,
  FLMGET_SECUREINFO =2002 , FLMGET_MODE =4001 , FLMGET_RLCOMPMODE =6001
}
 The flmget_parameter enum defines constants for the flmqry() function. More...
 

Functions

const char * pcFl4RecVersion (const int l, const int s, char *b)
 
const char * pcFl4RecAbout (const int l, const int s, char *b)
 
void flmopn (C08 **flmid, I32 *rc, I32 *lstpar, I32 *opmode, C08 *ddname, I32 *statis)
 Open a FLAMFILE.
 
void flmopd (C08 **flmid, I32 *rc, I32 *lstpar, I32 *namelen, C08 *dsname, I32 *org, I32 *recf, I32 *recs, U08 *recdel, FKD *keydesc, I32 *blks, I32 *cldisp, I32 *dev)
 Set/Get FLAMFILE organisation attributes.
 
void flmopf (C08 **flmid, I32 *rc, I32 *version, I32 *flcode, I32 *modus, I32 *maxbuf, I32 *header, I32 *maxrec, FKD *keydesc, I32 *blkmode, U08 *exk20, U08 *exd20)
 Set/Get FLAMFILE attributes.
 
void flmflu (C08 **flmid, I32 *rc, U32 *cputime, U32 *recin, U32 *bytin, U32 *bytoflin, U32 *recout, U32 *bytout, U32 *bytoflout)
 Flush FLAMFILE.
 
void flmeme (C08 **flmid, I32 *rc, U32 *cputime, U32 *recin, U32 *bytin, U32 *bytoflin, U32 *recout, U32 *bytout, U32 *bytoflout, U08 *membermac)
 End member in a FLAMFILE (only z/OS)
 
void flmdel (C08 **flmid, I32 *rc)
 Delete last record (only z/OS)
 
void flmfky (C08 **flmid, I32 *rc, I32 *keylen, U08 *record, I32 *checkmod)
 Find record using a key (only z/OS)
 
void flmfrn (C08 **flmid, I32 *rc, I32 *recno, I32 *checkmod)
 Find record number (only z/OS)
 
void flmgky (C08 **flmid, I32 *rc, I32 *reclen, U08 *record, I32 *buflen)
 Get record addressed by key (only z/OS).
 
void flmgrn (C08 **flmid, I32 *rc, I32 *reclen, U08 *record, I32 *buflen, I32 *recno)
 Get record by number (only z/OS)
 
void flmgtr (C08 **flmid, I32 *rc, I32 *reclen, U08 *record, I32 *buflen)
 Get previous record (only z/OS)
 
void flmiky (C08 **flmid, I32 *rc, I32 *reclen, U08 *record)
 Insert record with key (only z/OS)
 
void flmlcr (C08 **flmid, I32 *rc, I32 *reclen, U08 **recptr)
 Locate previous record (only z/OS)
 
void flmpky (C08 **flmid, I32 *rc, I32 *reclen, U08 *record)
 Put record by key (only z/OS)
 
void flmupd (C08 **flmid, I32 *rc, I32 *reclen, U08 *record)
 Update record (only z/OS)
 
void flmcls (C08 **flmid, I32 *rc, U32 *cputime, U32 *recin, U32 *bytin, U32 *bytoflin, U32 *recout, U32 *bytout, U32 *bytoflout)
 Close FLAMFILE.
 
void flmghd (C08 **flmid, I32 *rc, I32 *namelen, C08 *filename, I32 *org, I32 *recf, I32 *recs, U08 *recdel, FKD *keydesc, I32 *blks, I32 *prnctr, C08 *system)
 Get file header.
 
void flmphd (C08 **flmid, I32 *rc, I32 *namelen, C08 *filename, I32 *org, I32 *recf, I32 *recs, U08 *recdel, FKD *keydesc, I32 *blks, I32 *prnctr, C08 *system, I32 *cont)
 Put file header.
 
void flmguh (C08 **flmid, I32 *rc, I32 *hdrlen, C08 *header)
 Get user header.
 
void flmpuh (C08 **flmid, I32 *rc, I32 *hdrlen, C08 *header)
 Put user header.
 
void flmpwd (C08 **flmid, I32 *rc, U32 *pwdlen, C08 *passwd)
 Sets a password for encryption/decryption while compressing/decompressing.
 
void flmkme (C08 **flmid, I32 *rc, U32 *kmclen, U08 *kmc, const U32 *liblen, const C08 *lib, const U32 *fuclen, const C08 *fuc, const U32 *parlen, const C08 *par, U32 *msglen, C08 *msg, U32 *inflen, C08 *inf)
 Load and use FKME.
 
void flmpos (C08 **flmid, I32 *rc, I32 *pos)
 Set read position.
 
void flmget (C08 **flmid, I32 *rc, I32 *reclength, U08 *record, I32 *buflength)
 Get next record.
 
void flmloc (C08 **flmid, I32 *rc, I32 *reclength, U08 **record)
 Locate record.
 
void flmput (C08 **flmid, I32 *rc, I32 *reclength, U08 *record)
 Put record.
 
void flmerr (I32 *rc, I32 *msglen, const C08 **errmsg)
 Provides an error message.
 
void flmqry (C08 **flmid, I32 *rc, I32 *parameter, void *value)
 Query extended FLAMFILE attributes.
 
void flmset (C08 **flmid, I32 *rc, I32 *parameter, void *value)
 Set extended FLAMFILE attributes.
 

Detailed Description

Specification of FLAM4 Record Interface.

Author
limes datentechnik gmbh
Date
13.11.2019