FLAM4

Synopsis

HELP:   Read records from a FLAM4FILE
TYPE:   OBJECT
SYNTAX: FLAM4(NET.{},FILE['str'...],MEMBER='str',PRNCONTROL=DETACH/RETAIN/ERASE/REPLACE,RECCOUNT=num,RECLENGTH=num,TRUNCATE,PASSWORD/CRYPTOKEY='bin'/DEFAULT,KMLIBRARY='str',KMFUNCTION='str',KMPARAMETER='bin',CCSID='str'/DEFAULT/ASCII/EBCDIC/BOMUTF/BOMUCS/SYSTEM/LOCAL,CHRMODE=STOP/IGNORE/SUBSTITUTE/IDENTITY/TRANSLIT,SKIPEQUAL,USRTABLE='str'/NPAS/SEPA/DELA/DLAX,ONEMAP,COMBINED=NFD/NFC/AUTO/ON/OFF,BOM,KEEPBOM,REMOVE,RENAME='str',LANG='str',PLATFORM=WIN/UNX/ZOS/USS/VSE/BS2/MAC,OWNER='str',ENVID='str',HASH(),SIGNATURE.{},TABLE(),AVSCAN(),PREPROCESS[()...],POSTPROCESS/PSTPRO[()...],LARGER)

Description

Read FLAM4 works with a list of records from a FLAMFILE of version 4 or older. If such a record is text data, you can mark this by defining the correct CCSID. Such a definition will result in character set conversion from the provided CCSID to UTF-8 for each record. If no CCSID is provided, the record will be handled as binary data.

For FLAMFILE archives, these features are supported:

• Read all members or a dedicated member of the archive
• Print control character handling defined by a dedicated mode
• Pass phrase based or FKME based decryption technology
• Free definition of the amount of records handled as one chunk

User I/O, pre- and post-processing exits are not supported. If these features are required, please use the extended variant (XCMP/XCNV) of this command.

If you need, for example, Base64 decoding for records of a FLAMFILE, please use read.record(fdecode.base64). Read.record() can transparently read FLAMFILEs, supports base decoding and other useful features for record handling.

If you provide row specifications through the table object, each record is split into neutral FL5 table elements.

Arguments

• STRING: FILE['str'...] - Name/URL of the FLAMFILE to read [required]
• STRING: MEMBER='str' - Name or Index of the member in the FLAMFILE to read
• NUMBER: RECCOUNT=num - Amount of records handled in one read operation [4<128<1024]
• NUMBER: RECLENGTH=num - Maximum record length for read operation [512]
• SWITCH: TRUNCATE - Allow truncation of records [FALSE]
• STRING: PASSWORD/CRYPTOKEY='bin'/DEFAULT - Passphrase to decrypt the FLAMFILE ['']
  • DEFAULT - FLAM4 default password
• STRING: KMLIBRARY='str' - Library name for FKME ['']
• STRING: KMFUNCTION='str' - Function name of FKME ['']
• STRING: KMPARAMETER='bin' - Parameter for the call of FKME ['']
• SWITCH: SKIPEQUAL - Skip conversion if formats are equal (e.g. UTF-8 to UTF-8)
• SWITCH: KEEPBOM - Keep byte order mark for faster conversion