9.80 GET_COMPONENT_LIST

Note: Built-In Function Rules     Usage Options

Returns a list of Components. All simple fields will be ignored by this BIF. This will be done by processing one of the LANSA internal tables that list the components in one of the three selection methods. It will order the components by component name if the search type is by component, or by Group and component name if the search type is by Group, or by Framework and component if the search type is by Framework.

This is a Specialized Built-In Function for use in a Development Environment only.

 

Use

If all the search parameters are blank a search by component will be assumed.

By Component

To search by component the user will be required to provide a value for the Search Component parameter and leave Search Framework/Group blank.

To continue loading the list with subsequent data after receiving a return code of OV set the Search Component parameter to the value of the Last Component return value with Search Group/Framework set to blank. The BIF will use this as the pointer from which it will read the next set of information requested.

By Group/Framework

To search by group/framework the user will be required to provide a value for the Search Group/Framework parameter and leave Search Component.

To continue loading the list with subsequent data after receiving a return code of OV set the Search Group/Framework and Search Component parameters to the value of Last Group/Framework and Last Component return values. The BIF will use this as the pointer from which it will read the next set of information requested.

Arguments

No.

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Search Type

The type of search required.

Valid values:
CMP = by Component
FRW = by Framework
GRP = by Group

3

3

 

 

2

A

Opt

Search Component

Positioning Component value.

1

10

 

 

3

A

Opt

Search Framework/Group

Positioning Framework/Group

1

20

 

 

 

Return Values

No.

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

L

Req

Working list containing Component details.

The list must be in the following format and not contain more than 32,767 entries:

 

From - To   Description

1 - 10   Component Name

11 - 50   Component Description

51 - 70   Framework

71 - 90   Group

90

90

 

 

2

A

Req

The last Component in the returned list.

1

10

 

 

3

A

Req

The last Group/Framework in the returned list.

1

20

 

 

4

A

Req

Return Code

OK = list returned partially or completely filled with component details. No more Components exist beyond those returned in the list.

OV = list returned completely filled, but more Components than could fit in the list still exist.

NR = list was returned empty. Last Component/Framework/Group in list returned as blanks.

2

2