9 216 TEMPLATE_ SET

You are here:

9.216 TEMPLATE_@@SET_FILS

Note: Built-In Function Rules Usage Options

Allows file(s) from a list of files previously built by the TEMPLATE_@@GET_FILS Built-In Function to be "selected" for use within an application template that will be executed later.

Functionally this Built-In Function acts like the second step of the application template command @@GET_FILS in that a "selection" of files is made and set up for use by the application template.

In an application template the user selects files by entering a non-blank value beside them at the workstation. To perform this action from an RDML function use this Built-In Function.

This Built-In Function can only be used against a function that has been previously placed into an edit session by using the START_FUNCTION_EDIT Built-In Function.

Special Note: This Built-In Function provides access to very advanced facilities that basically allow RDML functions to construct new RDML functions.

This is a very specialized area that requires very good knowledge of the LANSA product. Use of this Built-In Function in a "commercial" application (e.g. Order Entry) is not normal and should not be attempted.

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

Arguments

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

Req

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

Req

List of related files previously built by the TEMPLATE_ @@GET_FILS command with the "selection" flag set to a non-blank value to indicate a file that is to be selected.

The first entry in the list is the base file and it must always be selected. Working list must have an aggregate length of 40 bytes and is formatted as follows:

From - ToDescription

1 - 1 Selection Flag. 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. If this file is a physical file then this name will be the same as the entry file name. Format Alpha.

33 - 35 Related file entry number.
Format Signed(3,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.
   P = Primary or Base File.
   O = One to One
   M = Many.

37 - 40 <<future expansion>> A(4)

Return Values