9.4 ACCESS_RTE
Þ Note: Built-In Function Rules.
Specifies or re-specifies the attributes of an access route between the definition of the file being edited and another file defined within the LANSA system.
For details of what an access route is and how they are used by the LANSA system refer to Access Routes to Other Files in the LANSA for i User Guide.
After using this Built-In Function to define the basic access route attributes, repetitively use the ACCESS_RTE_KEY Built-In Function to specify or re-specify the route key field(s) or value(s).
An edit session must be commenced by using the START_FILE_EDIT Built-In Function prior to using ACCESS_RTE.
Allowable argument values and adopted default values are as shown in the Detailed Access Route Maintenance described in the LANSA for i User Guide.
Þ 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 an 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 access route First 3 letters of the name must be the same as the edit "source" nominated in the START_FILE_EDIT Built-In Function.
|
1
|
10
|
|
|
|
2
|
A
|
Req
|
Description of access route
|
1
|
40
|
|
|
|
3
|
A
|
Req
|
File to be accessed via route
|
1
|
10
|
|
|
|
4
|
A
|
Req
|
Library in which file resides *FIRST and *DEFAULT are allowable.
In Visual LANSA blanks or *LIBL are also valid for backward compatibility.
|
1
|
10
|
|
|
|
5
|
N
|
Req
|
Maximum records expected Must be in range 1 - 9999.
|
1
|
4
|
0
|
0
|
|
6
|
A
|
Opt
|
Action to take if no records found via this route. Must be ABORT, IGNORE, N/AVAIL or DUMMY.
|
1
|
10
|
|
|
|
Return Values
|
No
|
Type
|
Req/ Opt
|
Description
|
Min Len
|
Max Len
|
Min Dec
|
Max Dec
|
|
1
|
A
|
Req
|
Return code
OK = access route defined
ER = error detected
In case of "ER" return code error message(s) are issued automatically and the edit session continues. The access route that caused the error is ignored in this and all subsequent requests during the edit session.
|
2
|
2
|
|
|
|