7 7 1 CALLCHECK Parameters

LANSA Technical

7.7.1 CALLCHECK Parameters

ADD_PARMS

BAD_RET

BY_CALLING

GOOD_RET

MSGDTA

MSGF

MSGID

MSGTXT

PROG_TYPE

FIELD

Specifies the name of the field which is to be validated.

BY_CALLING

Specifies the name of the program which is to be called to perform the validation of the field entered in the FIELD parameter. This parameter is a qualified name. The program name must be specified.

If required the library in which the program resides can also be specified. If no library name is specified, special value *LIBL is assumed which indicates the execution time library list of the function should be searched to locate the program.

PROG_TYPE

Specifies if the program to be called is a 3GL program or a function. If the program type is specified as a function, no additional parameters are allowed and the function must use option *DIRECT. Please, refer to the FUNCTION command for more details.

Portability Considerations

Calling of 3GL programs is not supported in the current release of Visual LANSA but will be supported in a future release.

A build warning will be generated if used in Visual LANSA code. An error will occur at execution time. Code using this facility can be conditioned so that it is not executed in this environment.

For further information refer to Calling 3GL Programs in the LANSA Application Design Guide.

ADD_PARMS

Specifies any additional parameters which should be passed to the program. See comments following for more details.

GOOD_RET

Specifies the action to be taken if the user program nominated in the BY_CALLING parameter gives a "good" return code. Refer to the comments section for more details of return codes.

If *NEXT is specified the field is considered to have passed the validation check. Processing will continue with the next RDML command.

If *ERROR is specified the field is considered to have failed the validation check. Either the message text specified in MSGTXT or the message specified in MSGID and MSGF parameters will be displayed on line 22/24 of the next screen format presented to the user. In addition the field named in the FIELD parameter will be displayed in reverse image and the screen cursor will be positioned to the first field on the screen that is in error. Processing continues with the next RDML command.

If *ACCEPT is specified the return code will be accepted and no further validation checks will be performed against the field named in the FIELD parameter within this validation block. Processing continues with the next RDML command. However, if this is another validation check against the same field it will be effectively "disabled" and not performed.

BAD_RET

Specifies the action to be taken if the user program nominated in the BY_CALLING parameter gives a "bad" return code. Refer to the comments section for more details of return codes.

If *NEXT is specified the field is considered to have passed the validation check. Processing will continue with the next RDML command.

If *ERROR is specified the field is considered to have failed the validation check. Either the message text specified in MSGTXT or the message specified in MSGID and MSGF parameters will be displayed on line 22/24 of the next screen format presented to the user. In addition the field named in the FIELD parameter will be displayed in reverse image and the screen cursor will be positioned to the first field on the screen that is in error. Processing continues with the next RDML command.

If *ACCEPT is specified the return code will be accepted and no further validation checks will be performed against the field named in the FIELD parameter within this validation block. Processing continues with the next RDML command. However, if this is another validation check against the same field it will be effectively "disabled" and not performed.

MSGTXT

Allows up to 80 characters of message text to be specified. The message text specified should be enclosed in quotes. Use either the MSGTXT parameter or the MSGID / MSGF parameters but not both.

MSGID

Allows a standard message identifier to be specified as the message that should be used. Message identifiers must be 7 characters long. Use this parameter in conjunction with the MSGF parameter.

MSGF

Specifies the message file in which the message identified in the MSGID parameter will be found. This parameter is a qualified name. The message file name must be specified. If required the library in which the message file resides can also be specified. If no library name is specified, library *LIBL is assumed.

MSGDTA

Use this parameter only in conjunction with the MSGID and MSGF parameters. It specifies from 1 to 20 values that are to be used to replace "&n" substitution variables in the message specified in the MSGID parameter.

Values in this parameter may be specified as field names, an expandable group expression, alphanumeric literals or numeric literals. They should exactly match in type, length and specification order the format of the substitution variables defined in the message.

When a field specified in this parameter has a type of signed (also called zoned) decimal, the corresponding "&n" variable in the message should have type *CHAR (character). This may cause a problem when dealing with negative values. In this case use packed decimal format instead.

When an "&n" variable in the message has type *DEC (packed decimal) the field specified in this message must be of packed decimal type.

When using alphanumeric literals in this parameter, remember that trailing blanks may be significant. For instance, if a message is defined as:

"&1 are out of stock ... reorder &2"
 

where &1 is defined as (*CHAR 10) and &2 as (*DEC 7 0), then the message will NOT be issued correctly if specified like this:

MSGDTA('BOLTS' #ORDQTY)
 

or like this:

MSGDTA('BOLTS     ' #ORDQTY)
 

To make LANSA aware of the trailing blanks, the parameter must be specified like this:

MSGDTA('''BOLTS     ''' #ORDQTY)

When expandable expressions are used, the expanded field list must not exceed the maximum number of substitution variables allowed in the parameter.