Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This is a Specialized Built-In Function for use in a Development Environment only.

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Name of application template that will be used later via the EXECUTE_TEMPLATE Built-In Function.

1

10



2

A

Req

Primary or base file name.

1

10



3

N

Opt

From file number.

Default value is 1.

1

2



4

N

Opt

To file number.

Default value is 50.

1

2



5

A

Opt

Physical Files Only.

Must be Y or N.

Default value is Y.

1

1



6

A

Opt

1:1 Relationships Only.

Must be Y or N.

Default value is Y.

1

1



Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return code

OK = operation completed

ER = fatal error detected

2

2



2

L

Req

Returned list of related files First entry will be the base file. Working list must have an aggregate length of 40 bytes and is formatted as follows:

From - To   Description

1 - 1   Selection Flag. Format Alpha.
First entry returned as X. Others returned as blanks.

2 - 11   File Name. Format Alpha.

12 - 21   File Library.
Format Alpha.

22 - 22   File Type
P =  Physical
L = Logical.

23 - 32   Underlying Physical File. Format Alpha.
If this file is a physical file then this name will be the same as the entry file name.

33 - 35   Related file entry number. Format Signed, length 3, decimal 0.
1 = the file is directly related to the base file or is the base file.
other = file is indirectly related to the base file via the file specified by this entry number.

36 - 36   Nature of relationship between this file and the related file. Format Alpha.
P = Primary or Base File.
O = One to One
M = Many.

37 - 40   <<Future expansion.>> Format Alpha.

.