9.162 PUT_FUNCTION_RDML

Note: Built-In Function Rules     Usage Options

Stores the RDML code associated with a function from a working list.

This Built-In Function can only be used against a function that has been previously placed into an edit session using the START_FUNCTION_EDIT Built-In Function.

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

L

Req

Working list Name

If the edit session is Include RDML audit stamps N, then the working list must have an aggregate entry length of 72 bytes where each entry is composed of:

From - To   Description

1 - 4   Command sequence number Signed(4, 0)

5 - 7   Command Label A(3)

8 - 17   Command A(10).

19 - 72   Command Parameters A(55).

If the edit session is Include RDML audit stamps Y, then the working list must have an aggregate entry length of 99 bytes, where, in addition to the positions described for Include RDML audit stamps N, each entry is composed of:

From - To   Description

73 - 73   Command Changed Flag, to be set to Y if the RDML command was added or changed in this edit session, N otherwise.A(1)

74 - 81    Command Changed Date S(8, 0). (CCYYMMDD). Must never be changed or set.

82 - 91   Command Changed User. Must never be changed or set. A(10).

92 - 99   Command Changed Task. Must never be changed or set. A(8).

 

 

 

 

2

A

Req

Nominated Editing Source Must not be blank or LAN. Used to "tag" edited RDML with last editor identifier.

*S=Signed

3

3

 

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return code

OK = operation completed

ER = fatal error detected

2

2

 

 

 

Technical Notes

If the function is being created by this edit session and the edit session is Include RDML audit stamps Y, the value of the Command Changed Flag is ignored.

Commands that have more than 55 bytes of parameters must be formatted across multiple entries as shown in this example:

Seq  Lab Command  Parameters

0001     **********   This is a comment line

0002     SET_MODE TO(*CHANGE)

0003 L32 GROUP_BY NAME(#GROUP) FIELDS(#FIELD001 #FIELD002

0003              #FIELD003 #FIELD004 #FIELD005 #FIELD006)

0004     DISPLAY  FIELDS(#GROUP)

0005     MENU

0006     **********  This is a comment line