9.103 GET_FIELD
Þ Note: Built-In Function Rules.
Retrieves attributes of a field stored in the LANSA Repository and returns them to the calling RDML function.
Returned values are exactly as presented in Detailed Display of a Field Definition in the LANSA for i User Guide.
For use with
|
LANSA for i
|
YES
|
|
Visual LANSA for Windows
|
YES
|
|
Visual LANSA for Linux
|
YES
|
|
Arguments
|
No
|
Type
|
Req/ Opt
|
Description
|
Min Len
|
Max Len
|
Min Dec
|
Max Dec
|
|
1
|
A
|
Req
|
Name of field to be retrieved from Repository
|
1
|
10
|
|
|
|
2
|
A
|
Opt
|
Name of process or *COMP if component
*COMP is not available inLANSA for i in non-RDMLX partitions.
|
1
|
10
|
|
|
|
3
|
A
|
Opt
|
Name of function or component. Compulsory if Arg 2 is provided.
If this argument is provided, the field in Arg 1 will be looked for first in the working fields for this function or component, and if not found as a working field, then the data dictionary will be searched. Note that the working field definitions for the function or component are as of the most recent compile.
|
1
|
10
|
|
|
|
Return Values
|
No
|
Type
|
Req/ Opt
|
Description
|
Min Len
|
Max Len
|
Min Dec
|
Max Dec
|
|
1
|
A
|
Req
|
Return code
OK = field details returned
ER = field not accessible
In case of "ER" return code error message(s) are issued automatically.
|
2
|
2
|
|
|
|
2
|
A
|
Opt
|
Field type
A = alpha
S = signed decimal numeric
P = packed decimal numeric
B = Binary
E = Date
F = Float
H = Char
I = Integer
M = Time
Z = DateTime
1 = String
2 = VarBinary
3 = CLOB
4 = BLOB
8=Nchar
9=NVarChar
|
1
|
1
|
|
|
|
3
|
N
|
Opt
|
Length of field or total number of digits in field. Length will be zero for types BLOB and CLOB.
|
3
|
15
|
0
|
0
|
|
4
|
N
|
Opt
|
Number of decimal positions Not applicable to all types.
|
1
|
15
|
0
|
0
|
|
5
|
A
|
Opt
|
Reference field name
|
1
|
10
|
|
|
|
6
|
A
|
Opt
|
Field description
|
1
|
40
|
|
|
|
7
|
A
|
Opt
|
Field label
|
1
|
15
|
|
|
|
8
|
A
|
Opt
|
List of 3 * A(20) headings
Bytes 1-20 are column head 1.
Bytes 21-40 are column head 2.
Bytes 41-60 are column head 3.
|
1
|
60
|
|
|
|
9
|
A
|
Opt
|
List of 10 * A(4) output attributes
|
1
|
40
|
|
|
|
10
|
A
|
Opt
|
List of 10 * A(4) input attributes
|
1
|
40
|
|
|
|
11
|
A
|
Opt
|
Edit code or edit word.
If first char is a quote (') then value is an edit word, otherwise it is an edit code.
Not applicable to type A field.
|
1
|
20
|
|
|
|
12
|
A
|
Opt
|
Default value of field
|
1
|
20
|
|
|
|
13
|
A
|
Opt
|
Optional alias name of field
|
1
|
30
|
|
|
|
14
|
A
|
Opt
|
System field flag
YES = a system field
NO = not a system field
|
3
|
3
|
|
|
|
15
|
A
|
Opt
|
Keyboard shift
|
1
|
1
|
|
|
|
16
|
A
|
Opt
|
Component (Y/N)
Note: Fields which have visualization return N.
|
1
|
1
|
|
|
|
17
|
A
|
Opt
|
Definition source
W: Working field
D: Data dictionary.
Will always be 'D' if process & function arguments not supplied.
|
1
|
1
|
|
|
|
18
|
A
|
Opt
|
Prompting process name
Return Blank for working field
|
1
|
10
|
|
|
|
19
|
A
|
Opt
|
Prompting function name
Return Blank for working field
|
1
|
7
|
|
|
|
20
|
A
|
Opt
|
Is field RDMLX?
Y=Field is RDMLX
N=Field is RDML.
|
1
|
1
|
|
|
|