DC@F47 - Built-In Function Definition

File Name:

DC@F47

Description:

Built-In Functions Definition file.

Normal Library:

<<pgmlib>>

 

Logical Views

Name Use Keys/Description/Comments

DC@F47V1

Read

F47BIF (unique).

DC@F47V2

Update

Same as DC@F47V1.

DC@F47V3

Read

F47IDN (unique).

DC@F47V4

Update

Same as DC@F47V3.

 

 

Record Layout

Field Name Type Len Dec Description / Comments / Values

F47BIF

A

20

 

Built-In Function name. This name can be from 4 to 20 characters long if a 3GL BIF, to 18 characters long if an RDML BIF. It must only contain letters of the English alphabet (A - Z), underscores (_), or numerals. Additionally, it must start with the string "UD_" (User Defined for your own use) or "OV_" (Other Vendor) as described in the Naming Conventions.

F47IDN

P

3

0

Unique number / identifier. Refer to the relevant Naming Conventions for recommended ranges of numbers to use.

Note: If you are developing BIFs in the 601-999 range, you must obtain from LANSA Technical Support (lansasupport@lansa.com.au) the next available number or a range of numbers for your use.

F47DES

A

40

 

A brief description of the Built-In Function in up to 40 characters.

F47COE

A

1

 

C or E. This determines whether the Built-In Function is C - Called or E - Executed within a function. In other words, whether this Built-In Function is a stand alone program or whether it will be part of the inline code of a LANSA function.

The use of C (called) is recommended, because of longer term portability considerations.

However, E (internally executed) subroutines generally offer better performance.

F47PGM

A

8

 

The name of a program to be called or the name of the RPG subroutine that is to be executed.

Refer to the relevant Naming Conventions for notes regarding this name.

F47SLR

A

1

 

N if the function is *HEAVYUSAGE.
Y if the function is *LIGHTUSAGE.

This option is only a consideration when:
- you are calling a program (type C)
or
- the language you are using allows the program to "stay active" between calls (e.g.: RPG or COBOL) and you intend to make use of this capability.

If these situations apply, then set this flag to N, otherwise set it to Y.

If this flag is set to N, then a special call will be placed to your program during termination of the RDML function indicating that your program should also terminate.

F47ARG

P

3

0

The number of arguments (BIF_ARGnn where nn is between 0 and 20) that are passed to the Built-In Function the WITH_ARGS parameter of the LANSA USE command.

F47RET

P

3

0

The number of returned values (BIF_RETnn where nn is between 0 and 20) that are passed by the Built-In Function in the TO_GET parameter of the LANSA USE command.