9 224 START_FUNCTION_EDIT

LANSA Technical

9.224 START_FUNCTION_EDIT

Þ Note: Built-In Function Rules.

Starts an "edit session" on the definition of a nominated LANSA function definition.

The edit session can be used to define a new function or alter an existing one.

A function edit session must be started and ended within a process edit session on the parent (i.e.: owning) process. Multiple edit sessions on functions within the same process may be conducted serially (but not concurrently) within the same process edit session.

For example:

START_PROCESS_EDIT

      START_FUNCTION_EDIT 

      << work with function A >> 

       END_FUNCTION_EDIT

END_PROCESS_EDIT

 

or:

START_PROCESS_EDIT

      START_FUNCTION_EDIT 

      << work with function A >> 

      END_FUNCTION_EDIT

 

      START_FUNCTION_EDIT 

      << work with function B >> 

      END_FUNCTION_EDIT

END_PROCESS_EDIT

 

The function definition is locked for exclusive use throughout the function edit session.

Only one function definition can be edited at one time (ie: it is not possible to concurrently edit two or more function definitions within the same job).

A function edit session should be terminated by using the END_FUNCTION_EDIT Built-In Function to ensure all locks/etc are released/shutdown in an orderly manner.

Any function edit session that receives a fatal error will have an END_FUNCTION_EDIT and an END_PROCESS_EDIT operation automatically issued.

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.

For use with

LANSA for i

YES

Do not use on IBM i in an RDMLX partition.

Visual LANSA for Windows

YES

 

Visual LANSA for Linux

NO

 

 

 

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Name of function to be edited

1

7

 

 

2

A

Opt

Function Description. Required for a new function only. Must not be blank. Default value is FUNCTION.

1

40

 

 

3

A

Opt

Initial public access.

Required for a new function only. ALL, NORMAL or NONE allowed. Default value is NORMAL.

3

6

 

 

4

A

Opt

Include RDML audit stamps (Y,N).

Controls the content and length of the RDML working lists used in the following Built-In Functions in this function edit session:
GET_FUNCTION_RDML
EXECUTE_TEMPLATE and PUT_FUNCTION_RDML

Y=RDML audit stamping is included in the RDML working lists used in this function edit session.

N=RDML audit stamping is not included in the RDML working lists used in this function edit session.

Default value is N.

1

1

 

 

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return code

OK = edit session commenced

ER = fatal error detected

2

2