9 83 GET_FIELD

You are here:

9.83 GET_FIELD_INFO

Note: Built-In Function Rules Usage Options

Retrieves a list of field related information from the LANSA internal database and returns it to the calling RDML function in variable length working lists.

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.

Arguments

No	Type	Req/ Opt	Description	Min Len	Max Len	Min Dec	Max Dec
1	A	Req	Field name	1	10
2	A	Req	Level at which information is requested D = Dictionary level F = File level	1	1
3	A	Req	Type of field related information to retrieve. Valid types are : FIELDCHECK - Validation rules MLATTR- Multilingual attributes REFFLD - Fields referring to the requested field	1	10
4	A	Opt	Physical file name. Required if file level information is requested.	1	10
5	A	Opt	Physical file library. Required if file level information is requested.	1	10

Return Values

No	Type	Req/ Opt	Description	Min Len	Max Len	Min Dec	Max Dec
1	A	Req	Return code OK = list returned partially or completely filled. No more of this type of information exists for this field. OV = list returned completely filled, but more of this type of information than could fit in the list exists. NR = list was returned empty. Last entry in the list is returned as null. ER = Field not found. Last entry in the list is returned as null.	2	2
2	L	Req	Header working list to contain field related information. The calling RDML function must: - provide a working list with an aggregate entry length of exactly 100 bytes. - contain no more than: 32,767 entries if Windows 9999 entries if IBM i . For type of field related information to retrieve see Format for header working list type FIELDCHECK: Format for header working list type MLATTR: Format for header working list type REFFLD:	100	100
3	L	Req	Detail working list to contain field related information. The calling RDML function must provide a working list with: - an aggregate entry length of exactly 100 bytes - contain no more than: 32,767 entries if Windows 9999 entries if IBM i . Refer to: Format for detail working list type FIELDCHECK: Format for detail working list type MLATTR: Format for detail working list type REFFLD: for details.	100	100

Format for header working list type FIELDCHECK:

Bytes	Description
1-5	Number of the first entry in the detail list for this entry in character format. A value of 00000 denotes that there are no entries in the detail list for this entry.
6-10	Number of the last entry in the detail list for this entry in character format
11-12	Type of check. SL = Simple Logic, DC = Date Check, CF = File Check, CL = Complex Logic, RV = Range of Values, LV = List of Values
13-42	Description of check.
43-43	Enable check for ADD. Y = Check performed on ADD, U = Check performed on ADD USE, N = Check not performed on ADD.
44-44	Enable check for CHANGE. Y = Check performed on CHG, U = Check performed on CHG USE, N = Check not performed on CHG.
45-45	Enable check for DELETE. Y = Enable check, N = Do not enable check.
46-46	Action if check is true. N = Perform NEXT check, E = Issue fatal ERROR, A = ACCEPT value and do no more checking.
47-47	Action if check is false. N = Perform NEXT check, E = Issue fatal ERROR, A = ACCEPT value and do no more checking.
48-54	Error Message Number.
55-64	Message File Name.
65-74	Message File Library.
75-84	Name of program to be called to perform Complex Logic check. Blank if not Complex Logic check.
85-94	Name of file used in File check. Blank if not File check.

Format for header working list type MLATTR:

Bytes	Description
1-5	Number of the first entry in the detail list for this entry in character format. A value of 00000 denotes that there are no entries in the detail list for this entry.
6-10	Number of the last entry in the detail list for this entry in character format
11-14	Language code.
15-29	Label.
30-49	Column heading 1.
50-69	Column heading 2.
70-89	Column heading 3.

Format for header working list type REFFLD:

Bytes	Description
1-5	A value of 00000 since the detail list is not used for REFFLD information.
6-10	A value of 00000.
11-20	Field Name
21-60	Description

Format for detail working list type FIELDCHECK:

Bytes	Description
Type of check Simple Logic Each detail list entry is formatted as follows:
1-79	Condition line.
Type of check Date Check One detail list entry is formatted as follows:
1-8	Date format.
9-15	Number of days allowed into the past for specified date in character format.
16-22	Number of days allowed into the future for specified date in character format.
Type of check File Check Each detail list entry is formatted as follows:
1-20	Value used as a key to the file.
Type of check Complex Logic Each detail list entry is formatted as follows:
1-20	Value used as an additional parameter.
Type of check Range of Values Each detail list entry is formatted as follows:
1-20	Value used as low limit of range.
21-40	Value used as high limit of range.
Type of check List of Values. Each detail list entry is formatted as follows:
1 - 20	Value used as a list element.

Format for detail working list type MLATTR:

Bytes	Description
Each detail list entry is formatted as follows:
1-40	Field description.

Format for detail working list type REFFLD:

Bytes	Description
No information is returned in the detail list.