Previous Topic: PurposeNext Topic: Return Code


Arguments

The following table gives a brief description of each of the arguments.

Name

I/O

Description

RUNTIME-PARM1

input

Under CICS, this is CICS EXEC Interface Block - DFHEIBLK.

RUNTIME-PARM2

input

Under CICS, this is DFHCOMMAREA.

TIRNCRYP-CMCB

input/output

A pointer to a structure containing the following items:

DATA-BUFFER-PTR

input/ output

On input, a pointer to the starting location of the View Data and Client Security sections within the CFB work buffer.

On output, a pointer to the starting location of the area that now contains the encrypted version of the input data. The length of this encrypted data cannot exceed ENCRYPTION-MAX-SIZE.

BUFFER-SIZE

input/ output

On input, BUFFER-SIZE is the current buffer size (in bytes) of the data to be encrypted.

On output, BUFFER-SIZE should be updated by this exit to contain the length of the encrypted data. The length of the encrypted data cannot exceed ENCRYPTION-MAX-SIZE.

ENCRYPTION-MAX-SIZE

input

A field that contains the maximum available buffer space (in bytes) that the encrypted data can occupy.

TIRNCRYP-TRANCODE

input

A field that contains the trancode identifying the target server.

CLIENT-USERID

input

A field containing the userid originally sent by the client.

NEXT-LOCATION-PTR

input

Not used.

TIRNCRYP-RETURN-CODE

output

A 2-byte character field returning the result of the encryption attempt. The following values are supported:

ENCRYPTION-USED—defined as SPACES

ENCRYPTION-SIZE-EXCEEDED-MAX—defined as 01

ENCRYPTION-NOT-USED—defined as 02

ENCRYPTION-APPLICATION-ERROR—defined as 03

FAILURE-MSG

output

An 80-byte character field, to be populated by this exit, to describe the failure with a message of choice. This failure message will be incorporated into an error message that is returned back to the client. Used in conjunction with a return code of ENCRYPTION-APPLICATION-ERROR.