Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

7.33.1 DEFINE_MAP Parameters

FOR

CLASS

NAME

PASS

MANDATORY

DESC

HELP


Anchor
FOR
FOR
FOR

Parameter will be received by the associated routine.

...

A DEFINE_MAP of *Result indicates that a method routine has a defined result parameter. This is similar in concept to Intrinsic functions and allows a method routine to be used as part of an expression.

Anchor
CLASS
CLASS
CLASS

CLASS defines the type of value that is passed. The value of CLASS can be a repository-defined field. The field can be a simple field such as #SALARY or any of its visualizations such as #SALARY.VISUAL or #SALARY.MYPART.

...

Note that you can pass only a single value in a single DEFINE_MAP statement.

Anchor
NAME
NAME
NAME

Name uniquely identifies the mapped value. The name can be up to 20 characters long and it has to be preceded by a hash, just like a field name.

...

  • The same name can be used in different events, methods, and property routines.

  • The name should not contain any prefixes reserved for LANSA such as #PRIM_, #LANSA, #SYS, #COM and #LP.

Anchor
PASS
PASS
PASS

Use this parameter to specify how the supplied parameter is mapped to the variable name.

...

If the value is passed *BY_REFERENCE, the routine can access the value of the field and change it.

Anchor
MANDATORY
MANDATORY
MANDATORY

Use this parameter to specify whether the parameter being specified is mandatory (*YES).

...

define_map *result class(#prim_boln) name(#mValid) mandatory(false)

Anchor
DESC
DESC
DESC

You can specify a brief description for the mapped value using the DESC parameter. It can be 40 characters long.

Anchor
HELP
HELP
HELP

You can specify a longer description for the mapped value using the HELP parameter. The help text can be viewed using the Features option of the Help menu. It can be 250 characters long.