7 50 1 GET_ENTRY Parameters

LANSA Technical

7.50.1 GET_ENTRY Parameters

NUMBER

FROM_LIST

RET_STATUS

NUMBER

Specifies a numeric literal or numeric field that indicates the entry number of the list entry that is to be retrieved. As each entry is added to a list by the ADD_ENTRY command it is assigned a number that identifies it. List entries are numbered from 1 (first entry number) to 9999 (maximum possible last entry number) sequentially. By specifying a list entry number it is possible to retrieve an individual list entry.

FROM_LIST

Specifies the name of the list from which the entry should be retrieved.

The default value of *FIRST specifies that the first list declared in the RDML program by a DEF_LIST (define list) command is the list to be used (which may be a browse or a working list).

If a list name is used then the list name must be declared elsewhere in the RDML program by a DEF_LIST (define list) command.

RET_STATUS

Specifies the name of a field that is to receive the "return code" that results from the GET_ENTRY command.

If the default value of *STATUS is used the return code is placed into a special field called #IO$STS which can be referenced in the RDML program just like any other field.

If a user field is nominated to receive the return code it must be alphanumeric with a length of 2. Even if a user field is nominated the special field #IO$STS is still updated.

The GET_ENTRY command only returns 2 possible status codes. These are "OK" (the entry was successfully retrieved) or "NR" (the entry was not found).