Functions

Functions
void	FMUVSN (int *rtc, int *vsnLen, char *vsn)
	Version.
void	FMUABO (int *rtc, int *aboLen, char *abo)
	About.
void	FMULIC (int *rtc, int *licLen, char *lic)
	Get license text.
void	FMUENV (int *rtc, const int *sys, const int *std, const int *envLen, const char *envStr, int *cnt)
	Load the FLAM environment.
void	FMUARC (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)
	FLAM ARCHIVE - Archive handling function.
void	FMURSN (int *rsn, int *msgLen, char *msg)
	Returns reason code and message.
void	FMUHLP (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.
void	FMUSYN (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.
void	FMUDOC (int *rtc, const int *what, const int *pathLen, const char *path, const int *outLen, const char *out)
	Return documentation.
void	FMUPRO (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.

Detailed Description

Function Documentation

FMUVSN()

void FMUVSN ( int * rtc, int * vsnLen, char * vsn )

extern

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  'FMUVSN' USING F-RETCO, F-VSNLEN, F-VSN.

Sample call in PL1:

DCL FMUVSN ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUVSN_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 FMUVSN  ( 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)

FMUABO()

void FMUABO ( int * rtc, int * aboLen, char * abo )

extern

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  'FMUABO' USING F-RETCO, F-ABOLEN, F-ABO.

Sample call in PL1:

DCL FMUABO ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUABO_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 FMUABO  ( 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)

FMULIC()

void FMULIC ( int * rtc, int * licLen, char * lic )

extern

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  'FMULIC' USING F-RETCO, F-LICLEN, F-LIC.

Sample call in PL1:

DCL FMULIC ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMULIC_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 FMULIC  ( 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)

FMUENV()

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

extern

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  'FMUENV' USING F-RETCO, F-SYSENV, F-STDENV,
                     F-ENVLEN, F-ENVAR, F-ENVCNT.

Sample call in PL1:

DCL FMUENV ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUENV_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 FMUENV  ( 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)

FMUARC()

void FMUARC ( 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 )

extern

FLAM ARCHIVE - Archive handling function.

This function calls the ARCHIVE command of FLCL

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 37.
01  F-CMD-STR          PIC  X(18)     VALUE 'LIST(STORE.FILE(NAME=''./test.fl5''))'.
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  'FMUARC' 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 FMUINFO ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUINFO_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(37)        INIT
           ('LIST(STORE.FILE(NAME=''./test.fl5''))'),
           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 FMUINFO ( 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

FMURSN()

void FMURSN ( int * rsn, int * msgLen, char * msg )

extern

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  'FMURSN'  USING F-RETCO, F-CMD-LEN, F-CMD-STR.

Sample call in PL1:

DCL FMURSN ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMURSN,
           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 FMURSN  ( 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)

FMUHLP()

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

extern

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     1.
    88 CMD-ARCHIVE     VALUE  1.
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 'archive.comp'.
01  F-OLEN             PIC S9(8) COMP VALUE     0.
01  F-OSTRING          PIC  X(45)     VALUE SPACE.
PROCEDURE DIVISION.
CALL  'FMUHLP'  USING F-RETCO, F-WHAT,     F-DEPTH,
                               F-PATH-LEN, F-PATH,
                               F-OLEN,     F-OSTRING.

Sample call in PL1:

DCL FMUHLP ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUHLP,
           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  ('archive.deco'),
           2 F_OLEN     BIN FIXED(31,0) INIT   (0),
           2 F_OSTRING  CHAR(45)        INIT  (' ');
CALL FMUHLP  ( 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

FMUSYN()

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

extern

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     1.
    88 CMD-ARCHIVE     VALUE  1.
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 'achive.list'.
01  F-OLEN        PIC S9(8) COMP VALUE  0.
01  F-OSTRING     PIC X(44)      VALUE ':STDERR'.
PROCEDURE DIVISION.
CALL  'FMUSYN'  USING F-RETCO, F-WHAT,     F-DEPTH,
                               F-PATH-LEN, F-PATH,
                               F-OLEN,     F-OSTRING.

Sample call in PL1:

DCL FMUSYN ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUSYN,
           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 ('archive.copy'),
           2 F_OLEN      BIN FIXED(31,0) INIT    (0),
           2 F_OSTRING   CHAR(44)        INIT (':STDERR');
CALL FMUSYN  ( 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

FMUDOC()

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

extern

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     1.
    88 CMD-ARCHIVE     VALUE  1.
01  F-PATH-LEN    PIC S9(8) COMP VALUE 20.
01  F-PATH        PIC X(20)      VALUE 'archive.update'.
01  F-OLEN        PIC S9(8) COMP VALUE  7.
01  F-OSTRING     PIC X(45)      VALUE ':STDERR'.
PROCEDURE DIVISION.
CALL  'FMUDOC'  USING F-RETCO, F-WHAT,
                               F-PATH-LEN, F-PATH,
                               F-OLEN,     F-OSTRING.

Sample call in PL1:

DCL FMUDOC ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUDOC,
           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 ('archive.delete'),
           2 F_OLEN      BIN FIXED(31,0) INIT    (7),
           2 F_OSTRING   CHAR(45)        INIT (':STDERR');
CALL FMUDOC  ( 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

FMUPRO()

void FMUPRO ( 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 )

extern

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     1.
    88 CMD-ARCHIVE     VALUE  1.
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  'FMUPRO'  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 FMUPRO ENTRY EXTERNAL OPTIONS (ASM, FETCHABLE);
   DCL  1  FMUPRO,
           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 FMUPRO  ( 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