9.5 ACCESS_RTE_KEY
Þ Note: Built-In Function Rules .
Specifies or re-specifies the name of a field or value that is to be used to access data via an access route previously defined via the ACCESS_RTE Built-In Function.
An edit session must be commenced by using the START_FILE_EDIT Built-In Function prior to using this Built-In Function.
Allowable argument values and adopted default values are described in Detailed Access Route Maintenance 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
|
Access route name
|
1
|
10
|
|
|
|
2
|
A
|
Req
|
Name of field from file being edited or a literal value that is to be used to form the key used to access data via the access route.
|
1
|
20
|
|
|
|
3
|
N
|
Opt
|
Optional sequencing number. Used to sequence key fields. If not specified keys are sequenced in the same order as they are presented.
|
1
|
5
|
0
|
0
|
|
Return Values
|
No
|
Type
|
Req/ Opt
|
Description
|
Min Len
|
Max Len
|
Min Dec
|
Max Dec
|
|
1
|
A
|
Req
|
Return code
OK = access key defined
ER = error detected
In the 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
|
|
|
|