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.

Enhanced_Security_Flag

Input

A single character denoting if the CFB has been created to support enhanced security. A value of Y denotes enhanced security,

*pTIRSECV_cmcb

Input

A pointer to a structure containing the following values:

client_userid

Input

A 64-byte character array containing a user ID if the CFB uses enhanced security. For a CFB containing standard security this parameter is expected to be blank.

client_password

Input

A 64-byte character array containing a password if the CFB uses enhanced security. For a CFB containing standard security this parameter is expected to be blank.

lSecurityTokenLen

Input

A long value representing the length of the pSecurityToken, if any.

pSecurityToken

Input

A pointer to a security token if the CFB uses enhanced security. For a CFB containing standard security this parameter is expected to be blank.

trancode

Input

An 8-byte character array containing the transaction code

return_code

Input/Output

A 2-byte character array containing a value denoting success for failure of this exit. Valid values are:

SECURITY_USED - defined as " "

SECURITY_NOT_USED—defined as "02"

SECURITY_APPLICATION_ERROR—defined as "03"

failure_msg

Input/Output

The pointer to an 80-character array that can be populated by this exit with a null terminated error message string. The string pointed to by this parameter will be incorporated into an error message that is returned back to the client. Used in conjunction with a return code of SECURITY_APPLICATION_ERROR.