Modifying Action Diagrams › Understanding Built-In Functions › Selection Parameters for Date Built-In Functions › Move Array › Move Array Usage

Move Array Usage

If you specify the ARR context, in addition to the code required for the *MOVE ARRAY function, CA 2E generates code to define the required array structures. Therefore, you can define these arrays automatically by using the *MOVE ARRAY function. When you generate a *MOVE ARRAY statement, CA 2E generates additional code that checks for array indexing errors.

Multiple instance arrays in 2E are 1-based; the first element in an array is element 1. You cannot specify a constant value (CON context) less than 1 or greater than the maximum number of elements in the array in the Action Diagram Editor. However, if you specify a runtime field value less than 1 or greater than the maximum number of elements in the array in the *Array index field, you receive an error.

If an array indexing error occurs, the PGM.*Return code field is set to a condition value of '*Array index error', which corresponds to the Y2U0068 message in the Y2USRMSG message file. This error can be monitored for as in the following example:

WRK.Product price = ARR.Item Array(WRK.Order line).Item price
.-CASE
¦-PGM.*Return code is *Array index error
¦ <-- *QUIT
'-ENDCASE

If *Result or *Factor 2 is not an array subfield, the following restrictions apply to that field:

• The related *Array and *Array index fields must be blank.
• The context specified must be one that would be valid in a *MOVE statement.
  • The valid contexts for *Result are PGM, LCL, WRK and NLL (including any valid parameter context, if the function has an appropriate output parameter).
  • The valid contexts for *Factor 2 are PGM, JOB, LCL, WRK, CND and CON. This context includes any valid parameter context, if the function has an appropriate input parameter.

If *Result or *Factor 2 is an array subfield then the following restrictions apply to that field.

• The related *Array and *Array index fields cannot be blank.
  • The *Array index can be a positive integer constant with a value greater than 0 and less than or equal to the number of elements in the array, or refer to a numeric variable with no decimal places.
  • The *Array index cannot itself be a subfield of a multiple-instance array.
• The context specified for *Result or *Factor 2, and the related *Array, must be one of the following contexts:

  ARR

  Valid for both *Result and *Factor 2.

  PAR

  Valid for *Result if the specified field exists as an Output, Both or Neither parameter field on a multiple-instance array parameter. Valid for *Factor 2 if the specified field exists as an Input, Both or Neither parameter field on a multiple-instance array parameter.

  PRn

  n is an integer 1–9.

  Same validity as PAR, but used where the function has duplicate parameters.

If *ALL is specified for either *Result or *Factor 2, the following restrictions apply:

• Certain context-specific restrictions apply when you specify here *ALL is specified:
  • If you specify *ALL for *Result, also specify *Factor 2 and vice-versa.
  • If you specify *ALL for *Result, you cannot specify CND and CON as the context for *Factor 2.
  • If you specify *ALL for *Factor 2, you cannot specify NLL as the context for *Result.
• Code is only generated to move a field if all the following conditions apply:
  • The field exists in both the *Factor 2 context and the *Result context
  • If the *Factor 2 context is a parameter context, the field must have a usage of O, B or N
  • If the *Result context is a parameter context, the field must have a usage of I, B or N
• Any target fields (or target array subfields) that exist in the *Result context, but do not exist in the *Factor 2 context, are not changed.

Note: The same field type validation rules apply to *MOVE ARRAY as to *MOVE, in terms of moving numeric fields to non-numeric fields.

From the main Action Diagram Editor screen, you can use the subfile option I=M to insert and prompt the *MOVE ARRAY built-in function.