Program Parameters - Code-1_Plus - 5.0

CODE-1 Plus Guide for IBM i

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
CODE-1 Plus
Version
5.0
Language
English
Product name
CODE-1 Plus
Title
CODE-1 Plus Guide for IBM i
Copyright
2024
First publish date
1998
Last updated
2024-07-11
Published on
2024-07-11T02:24:45.851825

Eleven logical parameters are passed in a single 01 level. These eleven parameters are as follows:

Position

Name

Length in Bytes

Contents

1-2

EXIT-FUNCTION

2

Function code for this call. Your program must pass one of the following function codes:

  • CL — Close the file.

  • OP — Open the file.

  • UR — Perform a read.

  • UW — Perform a write.

3-42

UXIT-COMMAND-LINE

40

Command line from the Interactive CODE-1 Plus Command field.

43-121

UXIT-PROMPT-MESSAGE

79

Message prompt that appears on the online screen after the return from this program.

122

UXIT-COMMAND

1

Indicates whether or not to clear the command after completion of the UR or UW command.

  • Y — Clear the Command field after completion of the UR or UW command.

  • N — Do not clear the Command field.

123

UXIT-ALARM

1

Indicates whether or not to sound an audible alarm at the completion of the UR or UW command.

  • Y — Sound an audible alarm at the completion of the UR or UW command.

  • N — Do not sound an alarm.

124

UXIT-ADDRESS

1

Indicates whether or not to clear the address upon completion of the UW command. Not used during the processing for a UR command.

  • Y — Clear the address area upon completion of the UR or UW command.

  • N — Do not clear the address area.

125

UXIT-CURSOR

1

Indicates whether or not to place the cursor in the address fields at the completion of the UR or UW command.

  • Y — Place the cursor in the address area.

  • N — Place the cursor at the Command field.

  • M — Place the cursor at the Command field on a match, or in the address area on a non-match or multiple.

126-221

UXIT-RESERVED

96

Reserved.

222-721

UXIT-P9IN

500

During the processing for a UR command, this program should place the address which it is preparing to enter onto the online screen into  this area. This field is not used during the processing of a UW command.

722-5721

UXIT-P9OUT

5,000

During the processing for a UW command, this area contains the P9OUT area for the current address at the time the UW command was  invoked. Not used during the processing of a UW command.

5722-6121

UXIT-P9AUDT

400

During the processing for a UW command, this area contains the P9AUDT area for the current address at the time the UW command was invoked. Not used during the processing of a UR command.

6122-6621

UXIT-SAVE-AREA

500

Memory that is statically allocated and preserved between invocations of the user exit.