| Note: Built-In Function Rules Usage Options |
Specifies or re-specifies the name of a field that is a key of a logical view / file previously defined by the LOGICAL_VIEW Built-In Function.
Prior to using this Built-In Function an edit session must be commenced by using the START_FILE_EDIT Built-In Function .
Allowable argument values and adopted default values are as described in Detailed Logical View Maintenance in the LANSA for i User Guide.
| Warning: This Built-In Function cannot be used for a file of type "OTHER". |
This is a Specialized Built-In Function for use in a Development Environment only.
No | Type | Req/ Opt | Description | Min Len | Max Len | Min Dec | Max Dec |
|---|---|---|---|---|---|---|---|
1 | A | Req | Name of logical view to which key is to belong. | 1 | 10 | ||
2 | A | Req | Name of key field. Must have been previously specified as a field in the file by using the FILE_FIELD Built-In Function. | 1 | 10 | ||
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 |
4 | A | Opt | Ascending or Descending key. Must be A or D. Default is A. | 1 | 1 | ||
5 | A | Opt | Signed, Unsigned or Absolute value ordering of numeric key. Must be S,U or A. Default is U for alphas and S for numerics. | 1 | 1 |
No | Type | Req/ Opt | Description | Min Len | Max Len | Min Dec | Max Dec |
|---|---|---|---|---|---|---|---|
1 | A | Req | Return code OK = key defined ER = fatal error detected In case of "ER" return code error message(s) are issued automatically and the edit session ended without commitment. | 2 | 2 |