Previous Topic: PurposeNext Topic: Return Code


Arguments

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

Name

I/O

Description

*rp1

Input

A pointer to a parameter control block. Reserved for runtime internal use only.

*rp2

Input

A pointer to a parameter control block. Reserved for runtime internal use only.

*pTIRNCRYP_cmcb

Input/Output

A pointer to a structure containing the following items:

pDataBuffer

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 this same data area should be populate by this exit with the encrypted versions of the input data. The length of the encrypted result cannot exceed lEncryptMaxSize.

lBufferSize

Input/Output

On input, lBufferSize is the current buffer space (in bytes) of the unencrypted data.

On output, IBuffferSize should be updated by this exit to contain the length of the encrypted data. The length of the encrypted result cannot exceed lEncryptMaxSize.

lEncryptMaxSize

Input

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

trancode

Input

Transaction code currently being processed. . This value can be used in conjunction with client userid and NextLocation to determine if encryption is desired.

client_userid

Input

Client user ID. This value can be used in conjunction with trancode and NextLocation to determine if encryption is desired.

pNextLocation

Input

Next Location value as set by the server application using CA Gen action diagram statements. This value can be used in conjunction with trancode and client userid to determine if encryption is desired.

return_code

Output

A two-character array returning the results of the decryption attempt. The following values are supported:

ENCRYPTION_USED—defined as " "

ENCRYPTION_SIZE_EXCEEDED_MAX—defined as "01"

ENCRYPTION_NOT_USED—defined as "02"

EnCRYPTION_APPLICATION_ERROR—defined as "03"

*failureMsg

Output

The pointer to an 80-character array, to be populated by the exit that can receive a null terminated error message string. The string pointed to by the failureMsg pointer 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.