Exit control block description

Table 1. Exit control block
Description	Data type	Set by:	Value
Eye catcher	CL8	FM initialization	'UFLDXCB'
Version	F	FM initialization	1 Initial value
Function Code	F	FM for every call to the exit	1 Initialize - once per field 2 Scramble - each time the field is copied 3 Terminate - once per field
Input Field Address	A	FM, for every scramble call	Field area address of the input field value
Input Field Length	F	FM, for every scramble call	Field length of the input field value area
Input Field Subscript Address	A	FM, for every scramble call	For dimensioned fields this contains the address of an array of fullword subscripts values
Input Field Dimensions	F	FM, for every scramble call	Number of subscripts for dimensioned fields
Input Field Name Address	A	FM, for every scramble call	Address of template or copybook field name
Input Field Name Length	H	FM, for every scramble call	Template or copybook field name length
Input field type	H	FM for every scramble call	1 Alphanumeric (includes alphabetic, and group items). 2 Binary. 3 Packed decimal. 4 Zoned decimal. 5 Numeric edit. 6 External floating point. 7 Floating point. 8 Decimal floating point. 9 Date. 10 Time. 11 Timestamp. 12 DBCS.
Input nullable	CL1	FM for every scramble call	(Y/N). Y is for Db2® nullable columns, otherwise N.
Input varying	CL1	FM for every scramble call	(Y/N). Y is for varying field or column, otherwise N.
Input varying	CL1	FM for every scramble call	(Y/N). Y is for varying null terminated strings, otherwise N.
Input signed	CL1	FM for every scramble call	For COBOL: 0 No sign clause. 1 Leading sign. 2 Leading sign separate. 3 Trailing. 4 Trailing sign separate. For PL/I: Y Signed. N Not signed.
Input Db2® null indicator	H	FM for every scramble call	Db2® null indicator. Only valid for Db2® nullable columns.
Input varying field length	H	FM for every scramble call	The length value for a varying field or column.
Input field precision	H	FM for every scramble call	This is the precision. That is, the number of significant digits of a binary, zoned or packed decimal field.
Input field scale	H	FM for every scramble call	The scale. That is, the number of digits to the right of the decimal point (it indicates where the decimal point would be positioned).
Output field address	A	FM for every scramble call	Field area address of the output field value.
Output field subscript address	A	FM for every scramble call	For dimensioned fields, this contains the address of an array of fullword subscript values.
Output field dimensions	F	FM for every scramble call	Number of subscripts for dimensioned fields.
Output field name address	A	FM for every scramble call	Address of Template or copybook field name.
Output field name length	H	FM for every scramble call	Template or copybook field name length.
Output field type	H	FM for every scramble call	1 Alphanumeric (includes alphabetic, and group items). 2 Binary. 3 Packed decimal. 4 Zoned decimal. 5 Numeric edit. 6 External floating point. 7 Floating point. 8 Decimal floating point. 9 Date. 10 Time. 11 Timestamp. 12 DBCS.
Output nullable	CL1	FM for every scramble call	(Y or N). Y is for Db2® nullable columns, otherwise N.
Output varying	CL1	FM for every scramble call	(Y or N). Y is for varying field or column, otherwise N.
Output varying	CL1	FM for every scramble call	(Y or N). Y is for varying null terminated strings, otherwise N.
Output signed	CL1	FM for every scramble call	For COBOL: 0 No sign clause. 1 Leading sign. 2 Leading sign separate. 3 Trailing. 4 Trailing sign separate. For PL/I: Y Signed. N Not signed.
Output field precision	H	FM for every scramble call	The precision. That is, the number of significant digits of a binary, zoned, or packed decimal field.
Output field scale	H	FM for every scramble call	The scale. That is, the number of digits to the right of the decimal point (it indicates where the decimal point would be positioned).
Return Code	F	FM sets to zero, exit sets on return	0 Successful. For Scramble option, the output value is used for the output field. 1 Random. Request for FM to perform random scrambling. Only valid for Scramble option. 2 Repeat. Request for FM to perform repeatable scrambling. Only valid for Scramble option. 3 Translate. Request for FM to perform translatable scrambling. This requires that a data set name and column in and column out values have been provided on the field attributes panel for this field. 8 Unsupported input field type. 10 Invalid input value. 16 Severe Error terminate.
Output field length	F	FM for every scramble call. Exit to set on return for formatted fields.	This value should be provided when returning a formatted numeric. The output area length is 80 and the returned length must be less than or equal to this.
Output null indicator	H	FM for every scramble call. Exit to set when returning for nullable field.	The exit can change the null indicator for nullable fields by setting this value.
Output varying length	H	FM for every scramble call. Exit can set when returning varying field.	The exit can set this value for a varying field on return. For any other type of field, the value is ignored.
User constant	CL80	FM for every scramble call	This contains the constant defined during scramble exit specification in template edit.
User Area	CL1024	Exit to set the values. Same area is referenced for each call.	This is a user area for the exit to use and is available for every call to the exit.