FLUCUPLB-API FLUC Load Module Interface

Functions
Functions

## Functions
void | FCUVSN (int *rtc, int *vsnLen, char *vsn)
| Version. More...
void | FCUABO (int *rtc, int *aboLen, char *abo)
| About. More...
void | FCULIC (int *rtc, int *licLen, char *lic)
| Get license text. More...
void | FCUENV (int *rtc, const int *sys, const int *std, const int *envLen, const char *envStr, int *cnt)
| Load the FLAM environment. More...
void | FCUINFO (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC INFO - Provides various information. More...
void | FCUUTIL (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC UTIL - Runs various simply functions on wildcard file lists. More...
void | FCUCONV (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC CONV - Simplified data conversion. More...
void | FCUXCNV (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC XCNV - Extended data conversion. More...
void | FCUGREP (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC GREP - Matching pattern in files like GREP. More...
void | FCUICNV (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC ICNV - Character conversion like ICONV. More...
void | FCUFLAM (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC FLAM - Support of FLAM4 command in FLUC. More...
void | FCUXCHK (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC XCHK - Support of XCHK command in FLUC. More...
void | FCUHASH (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC HASH - Support of HASH command in FLUC. More...
void | FCUDIFF (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC DIFF - Compares two data sources. More...
void | FCUKEY (int *rtc, const int *cmdLen, const char *cmd, const int *proLen, const char *pro, const int *outLen, const char *out, const int *trcLen, const char *trc)
| FLUC KEY - Key management functions. More...
void | FCURSN (int *rsn, int *msgLen, char *msg)
| Returns reason code and message. More...
void | FCUHLP (int *rtc, const int *what, const int *depth, const int *pathLen, const char *path, const int *outLen, const char *out)
| Returns help information about the command strings. More...
void | FCUSYN (int *rtc, const int *what, const int *depth, const int *pathLen, const char *path, const int *outLen, const char *out)
| Return syntax information about the command string. More...
void | FCUDOC (int *rtc, const int *what, const int *pathLen, const char *path, const int *outLen, const char *out)
| Return documentation. More...
void | FCUPRO (int *rtc, const int *what, const int *iproLen, const char *ipro, const int *propLen, const char *prop, const int *oproLen, const char *opro, const int *outLen, const char *out)
| Manage properties. More...

## Detailed Description

## Function Documentation

## ◆ FCUVSN()

void FCUVSN | ( | int * | rtc,
|  | int * | vsnLen,
|  | char * | vsn
| ) |  |

Version.

This function writes a string containing version information for every used component into the 'vsn' parameter. This should be used in a support case.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO         PIC S9(8)  COMP VALUE     0.
    01  F-VSNLEN        PIC S9(8)  COMP VALUE    30.
    01  F-VSN           PIC  X(30)      VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUVSN' USING F-RETCO, F-VSNLEN, F-VSN.

Sample call in PL1:

    DCL FCUVSN ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUVSN_PARAMETER,
               2 F_RETCO          BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_VSNLEN         BIN FIXED(31,0) INIT  (30),
               2 F_VSN            CHAR(30)        INIT (' ');
    CALL FCUVSN  ( F_RETCO,
                   F_VSNLEN,
                   F_VSN );

Parameters

  [out] | rtc | INTEGER Condition code
  [in,out] | vsnLen | INTEGER Size/length of version string
  [out] | vsn | STRING Version string (is null-terminated)

## ◆ FCUABO()

void FCUABO | ( | int * | rtc,
|  | int * | aboLen,
|  | char * | abo
| ) |  |

About.

This function writes a string with about information for this library on multiple lines and license information for used external libraries into the 'abo' parameter .

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO         PIC S9(8)  COMP VALUE     0.
    01  F-ABOLEN        PIC S9(8)  COMP VALUE    12.
    01  F-ABO           PIC  X(12)      VALUE 'Licence xyz\0'.
    PROCEDURE DIVISION.
    CALL  'FCUABO' USING F-RETCO, F-ABOLEN, F-ABO.

Sample call in PL1:

    DCL FCUABO ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUABO_PARAMETER,
               2 F_RETCO          BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_ABOLEN         BIN FIXED(31,0) INIT  (12),
               2 F_ABO            CHAR(12)        INIT ('Licence xyz\0');
    CALL FCUABO  ( F_RETCO,
                   F_ABOLEN,
                   F_ABO );

Parameters

  [out] | rtc | INTEGER Condition code
  [in,out] | aboLen | INTEGER Size/length of about string
  [out] | abo | STRING About string (is null-terminated)

## ◆ FCULIC()

void FCULIC | ( | int * | rtc,
|  | int * | licLen,
|  | char * | lic
| ) |  |

Get license text.

This function can be used to get the current license text on multiple lines. The license text defines the permissible use of this library.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO         PIC S9(8) COMP VALUE     0.
    01  F-LICLEN        PIC S9(8) COMP VALUE    50.
    01  F-LIC           PIC  X(50)     VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCULIC' USING F-RETCO, F-LICLEN, F-LIC.

Sample call in PL1:

    DCL FCULIC ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCULIC_PARAMETER,
               2 F_RETCO          BIN FIXED(31,0) INIT    (0) ALIGNED,
               2 F_LICLEN         BIN FIXED(31,0) INIT   (50),
               2 F_LIC            CHAR(50)        INIT  (' ');
    CALL FCULIC  ( F_RETCO,
                   F_LICLEN,
                   F_LIC );

Parameters

  [out] | rtc | INTEGER Condition code
  [in,out] | licLen | INTEGER Size/length of license string
  [out] | lic | STRING Current license text (is null-terminated)

## ◆ FCUENV()

void FCUENV | ( | int * | rtc,
|  | const int * | sys,
|  | const int * | std,
|  | const int * | envLen,
|  | const char * | envStr,
|  | int * | cnt
| ) |  |

Load the FLAM environment.

This function load the FLAM system variables (only on z/OS or in EDZ environment), the STDENV definitions ('DD:STDENV' or '<SYSUID>.STDENV' on z/OS or '.stdenv' file in working or home directory on other system) and a optional list if variables to the environment. You can adjust the environment before the first call to a FLAM API function is done. This function gives the possibility to work with the same environment used by FLAM utilities, subsystems, etc.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO         PIC S9(8) COMP VALUE 0.
    01  F-SYSENV        PIC S9(8) COMP VALUE 1.
    01  F-STDENV        PIC S9(8) COMP VALUE 1.
    01  F-ENVLEN        PIC S9(8) COMP VALUE 31.
    01  F-ENVAR         PIC  X(31)
        VALUE 'KEYWORD1=VALUE1;KEYWORD2=VALUE2'
    01  F-ENVCNT        PIC S9(8) COMP VALUE 0.
    PROCEDURE DIVISION.
    CALL  'FCUENV' USING F-RETCO, F-SYSENV, F-STDENV,
                         F-ENVLEN, F-ENVAR, F-ENVCNT.

Sample call in PL1:

    DCL FCUENV ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUENV_PARAMETER,
               2 F_RETCO          BIN FIXED(31,0) INIT (0) ALIGNED,
               2 F_SYSENV         BIN FIXED(31,0) INIT (1),
               2 F_STDENV         BIN FIXED(31,0) INIT (1),
               2 F_ENVLEN         BIN FIXED(31,0) INIT (31),
               2 F_ENVAR          CHAR(31)        INIT
                 ('KEYWORD1=VALUE1;KEYWORD2=VALUE2'),
               2 F_ENVCNT         BIN FIXED(31,0) INIT (0);
    CALL FCUENV  ( F_RETCO,
                   F_SYSENV,
                   F_STDENV,
                   F_ENVLEN,
                   F_ENVAR,
                   F_ENVCNT );

Parameters

  [out] | rtc | INTEGER Return code
  [in] | sys | INTEGER True to load system variables, NULL or false no system variables active
  [in] | std | INTEGER True to load standard environment, NULL or false no standard environment variables active
  [in] | envLen | INTEGER Length of the optional environment string (NULL if optional or if zero termination)
  [in] | envStr | STRING Optional list (could be NULL or empty) of environment variables (KEYWORD=VALUE) separated by new line ('\n') or semicolon (';')
  [out] | cnt | INTEGER Amount of environment variables set (optional, could be NULL)

## ◆ FCUINFO()

void FCUINFO | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC INFO - Provides various information.

This function calls the INFO command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE  0.
    01  F-CMD-LEN          PIC S9(8) COMP VALUE 18.
    01  F-CMD-STR          PIC  X(18)     VALUE 'get.file=''test.gz'''.
    01  F-PRP-STR-LEN      PIC S9(8) COMP VALUE  0.
    01  F-PRP-STR          PIC  X(200)    VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8) COMP VALUE  7.
    01  F-OFILE-NAME       PIC  X(7)      VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8) COMP VALUE  0.
    01  F-TRFILE-NAME      PIC  X(45)     VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUINFO' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUINFO ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUINFO_PARAMETER,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (18),
               2 F_CMD_STR         CHAR(18)        INIT
               ('get.file=''test.gz'''),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(45)        INIT (' ');
    CALL FCUINFO ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with GET and LOG instructions
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with GET and LOG instructions
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUUTIL()

void FCUUTIL | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC UTIL - Runs various simply functions on wildcard file lists.

This function calls the UTIL command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8)   COMP VALUE  0.
    01  F-CMD-LEN          PIC S9(8)   COMP VALUE 10.
    01  F-CMD-STR          PIC  X(10)       VALUE '~.test.**'''.
    01  F-PRP-STR-LEN      PIC S9(8)   COMP VALUE  0.
    01  F-PRP-STR          PIC  X(200)      VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8)   COMP VALUE  0.
    01  F-OFILE-NAME       PIC  X(45)       VALUE SPACE.
    01  F-TRFILE-NAME-LEN  PIC S9(8)   COMP VALUE  0.
    01  F-TRFILE-NAME      PIC  X(45)       VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUUTIL' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUUTIL ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUUTIL_PARAMETER,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (10),
               2 F_CMD_STR         CHAR(10)        INIT  ('~.test.**'''),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (0),
               2 F_OFILE_NAME      CHAR(45)        INIT (' '),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(45)        INIT (' ');
    CALL FCUUTIL ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with RUN and LOG instructions
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with RUN and LOG instructions
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUCONV()

void FCUCONV | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC CONV - Simplified data conversion.

This function calls the CONV command of FLUC

Example (Cobol):

     01  FCUCONV-PARAMETER.
        02  F-RETCO     PIC S9(8)   COMP VALUE ZERO.
           88 FLAM-OK                    VALUE    0.
        02  F-CMDLEN    PIC S9(8)   COMP VALUE  300.
        02  F-COMMAND   PIC  X(300)      VALUE
        'READ.RECORD(FILE=''DD:INPUT'' CCSID=''1141'' SUPPAD)
        'WRITE.TEXT(FILE=''DD:OUTPUT''
        ' METHOD=WINDOWS CCSID=''1252'' COMP.GZIP())'.
        02  F-PROLEN    PIC S9(8)   COMP VALUE    0.
        02  F-PROPERTY  PIC  X(200)      VALUE  ' '.
        02  F-LOGLEN    PIC S9(8)   COMP VALUE    9.
        02  F-LOGFILE   PIC  X(9)        VALUE 'DD:LOGOUT'.
        02  F-TRCLEN    PIC S9(8)   COMP VALUE ZERO.
        02  F-TRCFILE   PIC  X(45).
    PROCEDURE DIVISION.
    CALL 'FCUCONV' USING F-RETCO,
                         F-CMDLEN,
                         F-COMMAND,
                         F-PROLEN,
                         F-PROPERTY,
                         F-LOGLEN,
                         F-LOGFILE,
                         F-TRCLEN,
                         F-TRCFILE.

Sample call in PL1:

    DCL FCUCONV ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUCONV_PARAMETER,
               2 F_RETCO          BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMDLEN         BIN FIXED(31,0) INIT (300),
               2 F_COMMAND        CHAR(300)       INIT
             ('READ.RECORD(FILE=''DD:INPUT'' CCSID=''1141'' SUPPAD)WRITE.TE
    XT(FILE=''DD:OUTPUT'' METHOD=WINDOWS CCSID=''1252'' COMP.GZIP())' ),
               2 F_PROLEN         BIN FIXED(31,0) INIT   (0),
               2 F_PROPERTY       CHAR(200)       INIT (' '),
               2 F_LOGLEN         BIN FIXED(31,0) INIT   (9),
               2 F_LOGFILE        CHAR(9)         INIT ('DD:LOGOUT'),
               2 F_TRCLEN         BIN FIXED(31,0) INIT   (0),
               2 F_TRCFILE        CHAR(45)        INIT (' ');
    CALL FCUCONV ( F_RETCO,
                   F_CMDLEN,
                   F_COMMAND,
                   F_PROLEN,
                   F_PROPERTY,
                   F_LOGLEN,
                   F_LOGFILE,
                   F_TRCLEN,
                   F_TRCFILE );

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with READ, WRITE and LOG instructions
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with READ, WRITE and LOG instructions
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUXCNV()

void FCUXCNV | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC XCNV - Extended data conversion.

This function calls the XCNV command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE   0.
    01  F-CMD-LEN          PIC S9(8) COMP VALUE 300.
    01  F-CMD-STR          PIC  X(300)    VALUE
        'inp(sav.fil(fio.blk(name='test.txt')
        'cnv.chr(from=''IBM-1141''
        'to=''UTF-8'') fmt.txt()))
        'out(sav.fil(fio.blk(name='test.out')))'.
    01  F-PRP-STR-LEN      PIC S9(8) COMP VALUE  0.
    01  F-PRP-STR          PIC  X(200)    VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8) COMP VALUE  7.
    01  F-OFILE-NAME       PIC  X(7)      VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8) COMP VALUE  0.
    01  F-TRFILE-NAME      PIC  X(45)     VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUXCNV' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUXCNV ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUXCNV_PARAMETER,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT (300),
               2 F_CMD_STR         CHAR(300)       INIT
             ('inp(sav.fil(fio.blk(name='test.txt nv.chr(from=''IBM-1141''
    cnv.chr(from=''IBM-1141'' to=''UTF-8'') fmt.txt())) out(sav.fil(fio.bl
    k(name='test.out')))' ),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(44)        INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(44)        INIT (' ');
    CALL FCUXCNV ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string ()
  [in] | cmd | STRING Command string with INP, OUT and LOG instructions
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with INP, OUT and LOG instructions
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUGREP()

void FCUGREP | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC GREP - Matching pattern in files like GREP.

This function calls the GREP command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8)  COMP VALUE   0.
    01  F-CMD-LEN          PIC S9(8)  COMP VALUE  62.
    01  F-CMD-STR          PIC  X(62)      VALUE
        'input=''~.**'' pattern=''^IBM'' output=''DD:OUTPUT'''
    01  F-PRP-STR-LEN      PIC S9(8)  COMP VALUE   0.
    01  F-PRP-STR          PIC  X(200)     VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8)  COMP VALUE   7.
    01  F-OFILE-NAME       PIC  X(7)       VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8)  COMP VALUE   0.
    01  F-TRFILE-NAME      PIC  X(45)      VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUGREP' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUGREP ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUGREP_PARAMETER,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (62),
               2 F_CMD_STR         CHAR(62)        INIT
             ('input=''~.**'' pattern=''^IBM'' output=''DD:OUTPUT'''),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(44)        INIT (' ');
    CALL FCUGREP ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with GREP parameter
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with GREP parameter
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUICNV()

void FCUICNV | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC ICNV - Character conversion like ICONV.

This function calls the ICNV command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8)  COMP VALUE   0.
    01  F-CMD-LEN          PIC S9(8)  COMP VALUE  62.
    01  F-CMD-STR          PIC  X(62)      VALUE
        'in=''test.txt'' from=''IBM-1141'' to=''UTF-8''
        'ENL2LF out=''test.out'''.
    01  F-PRP-STR-LEN      PIC S9(8)  COMP VALUE   0.
    01  F-PRP-STR          PIC  X(200)     VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8)  COMP VALUE   7.
    01  F-OFILE-NAME       PIC  X(7)       VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8)  COMP VALUE   0.
    01  F-TRFILE-NAME      PIC  X(45)      VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUICNV' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUICNV ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUICNV_PARAMETER,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (62),
               2 F_CMD_STR         CHAR(62)        INIT
             ('in=''test.txt'' from=''IBM-1141'' to=''UTF-8'' ENL2LF
    out=''test.out''' ),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(44)        INIT (' ');
    CALL FCUICNV ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with ICNV parameter
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with ICNV parameter
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUFLAM()

void FCUFLAM | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC FLAM - Support of FLAM4 command in FLUC.

This function calls the FLAM command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE   0.
    01  F-CMD-LEN          PIC S9(8) COMP VALUE 100.
    01  F-CMD-STR          PIC  X(100)    VALUE
        'COMP MODE=ADC FLAMIN=''test.txt''
        'FLAMFILE=''test.adc'''.
    01  F-PRP-STR-LEN      PIC S9(8) COMP VALUE   0.
    01  F-PRP-STR          PIC  X(200)    VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8) COMP VALUE   7.
    01  F-OFILE-NAME       PIC  X(7)      VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8) COMP VALUE   0.
    01  F-TRFILE-NAME      PIC  X(44)     VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUFLAM' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUFLAM ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUFLAM_PARAMETER,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT (100),
               2 F_CMD_STR         CHAR(100)       INIT
             ('COMP MODE=ADC FLAMIN=''test.txt'' FLAMFILE=''test.adc'''),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(44)        INIT (' ');
    CALL FCUFLAM ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with FLAM parameter
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with FLAM parameter
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUXCHK()

void FCUXCHK | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC XCHK - Support of XCHK command in FLUC.

This function calls the XCHK command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8)  COMP VALUE   0.
    01  F-CMD-LEN          PIC S9(8)  COMP VALUE  50.
    01  F-CMD-STR          PIC  X(50)      VALUE
        'inp(sav.fil(fio.blk(name=''test.txt'') cnv.hsh()))'.
    01  F-PRP-STR-LEN      PIC S9(8)  COMP VALUE   0.
    01  F-PRP-STR          PIC  X(200)     VALUE SPACE.
     01  F-OFILE-NAME-LEN  PIC S9(8)  COMP VALUE   7.
    01  F-OFILE-NAME       PIC  X(7)       VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8)  COMP VALUE   0.
    01  F-TRFILE-NAME      PIC  X(45)
        VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUXCHK' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUXCHK ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUXCHK,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (50),
               2 F_CMD_STR         CHAR(50)        INIT
             ('inp(sav.fil(fio.blk(name=''test.txt'') cnv.hsh()))'),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(44)        INIT (' ');
    CALL FCUXCHK ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with FLAM parameter
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with FLAM parameter
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUHASH()

void FCUHASH | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC HASH - Support of HASH command in FLUC.

This function calls the HASH command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE   0.
    01  F-CMD-LEN          PIC S9(8) COMP VALUE  30.
    01  F-CMD-STR          PIC  X(30)     VALUE
        'file=''test.txt'' algo=sha512'.
    01  F-PRP-STR-LEN      PIC S9(8) COMP VALUE   0.
    01  F-PRP-STR          PIC  X(200)    VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8) COMP VALUE   7.
    01  F-OFILE-NAME       PIC  X(7)      VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8) COMP VALUE   0.
    01  F-TRFILE-NAME      PIC  X(45)     VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUHASH' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUHASH ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUHASH,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (30),
               2 F_CMD_STR         CHAR(30)        INIT
             ('file=''test.txt'' algo=sha512'),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(45)        INIT (' ');
    CALL FCUHASH ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with FLAM parameter
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with FLAM parameter
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length of trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUDIFF()

void FCUDIFF | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC DIFF - Compares two data sources.

This function calls the DIFF command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE         0.
    01  F-CMD-LEN          PIC S9(8) COMP VALUE        56.
    01  F-CMD-STR          PIC  X(56)     VALUE
      'read.file=''./test.txt.gz'' compare.file=''~.test.fba'' DATA'.
    01  F-PRP-STR-LEN      PIC S9(8) COMP VALUE         0.
    01  F-PRP-STR          PIC  X(200)    VALUE     SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8) COMP VALUE         7.
    01  F-OFILE-NAME       PIC  X(7)      VALUE ':STDERR'.
    01  F-TRFILE-NAME-LEN  PIC S9(8) COMP VALUE         0.
    01  F-TRFILE-NAME      PIC  X(45)     VALUE     SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUDIFF' USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUDIFF ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUDIFF,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (56),
               2 F_CMD_STR         CHAR(56)        INIT
        ('read.file=''./test.txt.gz'' compare.file=''~.test.fba'' DATA'),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(44)        INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(44)        INIT (' ');
    CALL FCUDIFF ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with READ, COMPARE and LOG instructions
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with READ, COMPARE and LOG instructions
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCUKEY()

void FCUKEY | ( | int * | rtc,
|  | const int * | cmdLen,
|  | const char * | cmd,
|  | const int * | proLen,
|  | const char * | pro,
|  | const int * | outLen,
|  | const char * | out,
|  | const int * | trcLen,
|  | const char * | trc
| ) |  |

FLUC KEY - Key management functions.

This function calls the KEY command of FLUC

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8)  COMP VALUE     0.
    01  F-CMD-LEN          PIC S9(8)  COMP VALUE    32.
    01  F-CMD-STR          PIC  X(32)      VALUE
      'import.pgp(file=''./keyFile.pgp'')'.
    01  F-PRP-STR-LEN      PIC S9(8)  COMP VALUE     0.
    01  F-PRP-STR          PIC  X(200)     VALUE SPACE.
    01  F-OFILE-NAME-LEN   PIC S9(8)  COMP VALUE     7.
    01  F-OFILE-NAME       PIC  X(45)      VALUE ':STDERR'.
     01  F-TRFILE-NAME-LEN  PIC S9(8) COMP VALUE     0.
    01  F-TRFILE-NAME      PIC  X(45)      VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUKEY'  USING F-RETCO, F-CMD-LEN,         F-CMD-STR,
                                   F-PRP-STR-LEN,     F-PRP-STR,
                                   F-OFILE-NAME-LEN,  F-OFILE-NAME
                                   F-TRFILE-NAME-LEN, F-TRFILE-NAME.

Sample call in PL1:

    DCL FCUKEY ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUKEY,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN         BIN FIXED(31,0) INIT  (32),
               2 F_CMD_STR         CHAR(32)        INIT
        ('import.pgp(file=''./keyFile.pgp'''),
               2 F_PRP_STR_LEN     BIN FIXED(31,0) INIT   (0),
               2 F_PRP_STR         CHAR(200)       INIT (' '),
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT (':STDERR'),
               2 F_TRFILE_NAME_LEN BIN FIXED(31,0) INIT   (0),
               2 F_TRFILE_NAME     CHAR(45)        INIT (' ');
    CALL FCUKEY  ( F_RETCO,  F_CMD_LEN,         F_CMD_STR,
                             F_PRP_STR_LEN,     F_CMD_STR,
                             F_OFILE_NAME_LEN,  F_OFILE_NAME,
                             F_TRFILE_NAME_LEN, F_TRFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | cmdLen | INTEGER Length of command string (must be set)
  [in] | cmd | STRING Command string with IMPORT/EXPORT/... and LOG instructions
  [in] | proLen | INTEGER Length of property string (0 if no properties)
  [in] | pro | STRING Property string with IMPORT/EXPORT/... instructions
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts
  [in] | trcLen | INTEGER Length trace filename (if 0 no trace is written)
  [in] | trc | STRING Filename for tracing

## ◆ FCURSN()

void FCURSN | ( | int * | rsn,
|  | int * | msgLen,
|  | char * | msg
| ) |  |

Returns reason code and message.

This function returns the reason code and optional a message after a command fails. If the buffer is too small the message is truncated. 128 byte is a good size for the message buffer.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE      0.
    01  F-CMD-LEN          PIC S9(8) COMP VALUE    128.
    01  F-CMD-STR          PIC  X(128)    VALUE  SPACE.
    PROCEDURE DIVISION.
    CALL  'FCURSN'  USING F-RETCO, F-CMD-LEN, F-CMD-STR.

Sample call in PL1:

    DCL FCURSN ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCURSN,
               2 F_RETCO   BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_CMD_LEN BIN FIXED(31,0) INIT (128),
               2 F_CMD_STR CHAR(128)       INIT (' ');
    CALL FCURSN  ( F_RETCO, F_CMD_LEN, F_CMD_STR);

Parameters

  [out] | rsn | INTEGER Reason code (internal FLAM return code)
  [in,out] | msgLen | INTEGER Size/length of message string (if 0 no message is returned)
  [out] | msg | STRING Message string (is null-terminated and optional)

## ◆ FCUHLP()

void FCUHLP | ( | int * | rtc,
|  | const int * | what,
|  | const int * | depth,
|  | const int * | pathLen,
|  | const char * | path,
|  | const int * | outLen,
|  | const char * | out
| ) |  |

Returns help information about the command strings.

This function can be used to get all help messages or man pages for each parameter in the command string.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE     0.
    01  F-WHAT             PIC S9(8) COMP VALUE     5.
        88 CMD-INFO        VALUE  1.
        88 CMD-CONV        VALUE  2.
        88 CMD-XCNV        VALUE  3.
        88 CMD-ICNV        VALUE  4.
        88 CMD-FLAM        VALUE  5.
        88 CMD-XCHK        VALUE  6.
        88 CMD-HASH        VALUE  7.
        88 CMD-UTIL        VALUE  8.
        88 CMD-DIFF        VALUE  9.
        88 CMD-KEY         VALUE 10.
    01  F-DEPTH            PIC S9(8) COMP VALUE     8.
    01  F-PATH-LEN         PIC S9(8) COMP VALUE    20.
    01  F-PATH             PIC  X(20)     VALUE 'conv.read.text.ccsid'.
    01  F-OLEN             PIC S9(8) COMP VALUE     0.
    01  F-OSTRING          PIC  X(45)     VALUE SPACE.
    PROCEDURE DIVISION.
    CALL  'FCUHLP'  USING F-RETCO, F-WHAT,     F-DEPTH,
                                   F-PATH-LEN, F-PATH,
                                   F-OLEN,     F-OSTRING.

Sample call in PL1:

    DCL FCUHLP ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUHLP,
               2 F_RETCO    BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_WHAT     BIN FIXED(31,0) INIT   (5),
               2 F_DEPTH    BIN FIXED(31,0) INIT   (8),
               2 F_PATH_LEN BIN FIXED(31,0) INIT  (20),
               2 F_PATH     CHAR(200)       INIT  ('conv.read.text.ccsid'),
               2 F_OLEN     BIN FIXED(31,0) INIT   (0),
               2 F_OSTRING  CHAR(45)        INIT  (' ');
    CALL FCUHLP  ( F_RETCO,  F_WHAT,     F_DEPTH
                             F_PATH_LEN, F_PATH,
                             F_OLEN,     F_OSTRING);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | what | INTEGER Constant number for the corresponding command string
  [in] | depth | INTEGER Number of levels to display (0-Man page, 1-One Level, 2-Two Level, ..., <9-All)
  [in] | pathLen | INTEGER Length of path string (0 to start at root)
  [in] | path | STRING Path (e.g. conv.read.text.ccsid) to limit help to the (sub)tree of a certain object
  [in] | outLen | INTEGER Length of output filename (if 0 stderr is used)
  [in] | out | STRING Filename for printouts

## ◆ FCUSYN()

void FCUSYN | ( | int * | rtc,
|  | const int * | what,
|  | const int * | depth,
|  | const int * | pathLen,
|  | const char * | path,
|  | const int * | outLen,
|  | const char * | out
| ) |  |

Return syntax information about the command string.

This function can be used to determine the complete syntax of the command strings.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO       PIC S9(8) COMP VALUE  0.
    01  F-WHAT        PIC S9(8) COMP VALUE  5.
        88 CMD-INFO        VALUE  1.
        88 CMD-CONV        VALUE  2.
        88 CMD-XCNV        VALUE  3.
        88 CMD-ICNV        VALUE  4.
        88 CMD-FLAM        VALUE  5.
        88 CMD-XCHK        VALUE  6.
        88 CMD-HASH        VALUE  7.
        88 CMD-UTIL        VALUE  8.
        88 CMD-DIFF        VALUE  9.
        88 CMD-KEY         VALUE 10.
    01  F-DEPTH       PIC S9(8) COMP VALUE  8.
    01  F-PATH-LEN    PIC S9(8) COMP VALUE 20.
    01  F-PATH        PIC X(20)      VALUE 'conv.read.text.ccsid'.
    01  F-OLEN        PIC S9(8) COMP VALUE  0.
    01  F-OSTRING     PIC X(44)      VALUE ':STDERR'.
    PROCEDURE DIVISION.
    CALL  'FCUSYN'  USING F-RETCO, F-WHAT,     F-DEPTH,
                                   F-PATH-LEN, F-PATH,
                                   F-OLEN,     F-OSTRING.

Sample call in PL1:

    DCL FCUSYN ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUSYN,
               2 F_RETCO     BIN FIXED(31,0) INIT    (0) ALIGNED,
               2 F_WHAT      BIN FIXED(31,0) INIT    (5),
               2 F_DEPTH     BIN FIXED(31,0) INIT    (8),
               2 F_PATH_LEN  BIN FIXED(31,0) INIT   (20),
               2 F_PATH      CHAR(20)        INIT ('conv.read.text.ccsid'),
               2 F_OLEN      BIN FIXED(31,0) INIT    (0),
               2 F_OSTRING   CHAR(44)        INIT (':STDERR');
    CALL FCUSYN  ( F_RETCO,  F_WHAT,     F_DEPTH
                             F_PATH_LEN, F_PATH,
                             F_OLEN,     F_OSTRING);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | what | INTEGER Constant number for the corresponding command string
  [in] | depth | INTEGER Number of levels to display (0-Man page, 1-One Level, 2-Two Level, ..., <9-All)
  [in] | pathLen | INTEGER Length of path string (0 to start at root)
  [in] | path | STRING Path (e.g. conv.read.text.ccsid) to limit syntax to the (sub)tree of a certain object
  [in] | outLen | INTEGER Length of output filename (if 0 stderr is used)
  [in] | out | STRING Filename for printouts

## ◆ FCUDOC()

void FCUDOC | ( | int * | rtc,
|  | const int * | what,
|  | const int * | pathLen,
|  | const char * | path,
|  | const int * | outLen,
|  | const char * | out
| ) |  |

Return documentation.

This function can be used to determine the complete documentation of the corresponding command.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO       PIC S9(8) COMP VALUE  0.
    01  F-WHAT        PIC S9(8) COMP VALUE  5.
        88 CMD-INFO        VALUE  1.
        88 CMD-CONV        VALUE  2.
        88 CMD-XCNV        VALUE  3.
        88 CMD-ICNV        VALUE  4.
        88 CMD-FLAM        VALUE  5.
        88 CMD-XCHK        VALUE  6.
        88 CMD-HASH        VALUE  7.
        88 CMD-UTIL        VALUE  8.
        88 CMD-DIFF        VALUE  9.
        88 CMD-KEY         VALUE 10.
    01  F-PATH-LEN    PIC S9(8) COMP VALUE 20.
    01  F-PATH        PIC X(20)      VALUE 'conv.read.text.ccsid'.
    01  F-OLEN        PIC S9(8) COMP VALUE  7.
    01  F-OSTRING     PIC X(45)      VALUE ':STDERR'.
    PROCEDURE DIVISION.
    CALL  'FCUDOC'  USING F-RETCO, F-WHAT,
                                   F-PATH-LEN, F-PATH,
                                   F-OLEN,     F-OSTRING.

Sample call in PL1:

    DCL FCUDOC ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUDOC,
               2 F_RETCO     BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_WHAT      BIN FIXED(31,0) INIT   (5),
               2 F_PATH_LEN  BIN FIXED(31,0) INIT   (20),
               2 F_PATH      CHAR(20)        INIT ('conv.read.text.ccsid'),
               2 F_OLEN      BIN FIXED(31,0) INIT    (7),
               2 F_OSTRING   CHAR(45)        INIT (':STDERR');
    CALL FCUDOC  ( F_RETCO,  F_WHAT,
                             F_PATH_LEN, F_PATH,
                             F_OLEN,     F_OSTRING);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | what | INTEGER Constant number for the corresponding command string
  [in] | pathLen | INTEGER Length of path string (0 to start at root)
  [in] | path | STRING Path (e.g. conv.read.text.ccsid) to limit docu to the (sub)tree of a certain object
  [in] | outLen | INTEGER Length of output filename (if 0 stderr is used)
  [in] | out | STRING Filename for printouts

## ◆ FCUPRO()

void FCUPRO | ( | int * | rtc,
|  | const int * | what,
|  | const int * | iproLen,
|  | const char * | ipro,
|  | const int * | propLen,
|  | const char * | prop,
|  | const int * | oproLen,
|  | const char * | opro,
|  | const int * | outLen,
|  | const char * | out
| ) |  |

Manage properties.

This function can be used to manage a property file for one of the supported commands. You can generate a property file if 'ipro' not set and 'opro' defined. You can printout the properties if 'ipro' defined and 'opro' is not set. You can validate and copy property files if 'ipro' and 'opro' defined. You can adjust a property file if 'ipro' defined, 'prop' are used and 'opro' set.

Sample call in COBOL:

    WORKING-STORAGE SECTION.
    01  F-RETCO            PIC S9(8) COMP VALUE            0.
    01  F-WHAT             PIC S9(8) COMP VALUE            5.
        88 CMD-INFO        VALUE  1.
        88 CMD-CONV        VALUE  2.
        88 CMD-XCNV        VALUE  3.
        88 CMD-ICNV        VALUE  4.
        88 CMD-FLAM        VALUE  5.
        88 CMD-XCHK        VALUE  6.
        88 CMD-HASH        VALUE  7.
        88 CMD-UTIL        VALUE  8.
        88 CMD-DIFF        VALUE  9.
        88 CMD-KEY         VALUE 10.
    01  F-IPROLEN          PIC S9(8) COMP VALUE           10.
    01  F-IPRO             PIC X(10)      VALUE 'xxxxxxxxxx'.
    01  F-PROP-STR-LEN     PIC S9(8) COMP VALUE           10.
    01  F-PROP-STR         PIC X(10)      VALUE 'yyyyyyyyyy'.
    01  F-OPRO-STR-LEN     PIC S9(8) COMP VALUE           10.
    01  F-OPRO-STR         PIC X(200)     VALUE 'zzzzzzzzzz'.
    01  F-OFILE-NAME-LEN   PIC S9(8) COMP VALUE            7.
    01  F-OFILE-NAME       PIC X(7)       VALUE ':STDERR'.
    PROCEDURE DIVISION.
    CALL  'FCUPRO'  USING F-RETCO, F-WHAT,
                                   F-IPROLEN,        F-IPRO,
                                   F-PROP-STR-LEN,   F-PROP-STR,
                                   F-OPRO-STR-LEN,   F-OPRO-STR,
                                   F-OFILE-NAME-LEN, F-OFILE-NAME.

Sample call in PL1:

    DCL FCUPRO ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
       DCL  1  FCUPRO,
               2 F_RETCO           BIN FIXED(31,0) INIT   (0) ALIGNED,
               2 F_WHAT            BIN FIXED(31,0) INIT   (5),
               2 F_IPROLEN         BIN FIXED(31,0) INIT  (10),
               2 F_IPRO            CHAR(10)        INIT  ('xxxxxxxxxx'),
               2 F_PROP_STR_LEN    BIN FIXED(31,0) INIT  (10),
               2 F_PROP_STR        CHAR(10)        INIT  ('yyyyyyyyyy'),
               2 F_OPRO_STR_LEN    BIN FIXED(31,0) INIT  (10),
               2 F_OPRO_STR        CHAR(200)       INIT  ('zzzzzzzzzz');
               2 F_OFILE_NAME_LEN  BIN FIXED(31,0) INIT   (7),
               2 F_OFILE_NAME      CHAR(7)         INIT  (':STDERR');
    CALL FCUPRO  ( F_RETCO,  F_WHAT,
                             F_IPROLEN,        F_IPRO,
                             F_PROP_STR_LEN,   F_PROP_STR,
                             F_OPRO_STR_LEN,   F_OPRO_STR,
                             F_OFILE_NAME_LEN, F_OFILE_NAME);

Parameters

  [out] | rtc | INTEGER Condition code
  [in] | what | INTEGER Constant number for the corresponding command string
  [in] | iproLen | INTEGER Length of input property file string (0 to generate a property file)
  [in] | ipro | STRING Input property file string
  [in] | propLen | INTEGER Length of property string (if 0 then no manipulation of properties done)
  [in] | prop | STRING Property string to update the property file
  [in] | oproLen | INTEGER Length of output property file string (if 0 stdout is used)
  [in] | opro | STRING Output property file string
  [in] | outLen | INTEGER Length of output filename (if 0 no output is produced)
  [in] | out | STRING Filename for printouts