Previous Topic: ArgumentsNext Topic: Default Behavior


Return Code

The following table gives a brief description of each of the return codes:

Return Code

Description

SecurityNotUsed

Indicates to the runtime that the CLIENT_USER_ID, CLIENT_PASSWORD, and security token will NOT be used to populate any part of the cooperative flow request. The client side security variables will not be added to the CFB by the proxy runtime.

SecurityUsedStandard

Indicates to the runtime that at most eight (8) bytes of the CLIENT_USER_ID and at most eight (8) bytes of the CLIENT_PASSWORD data will be set into the CFB header. The associated request buffer will not contain a CFB Security Offset area, and will therefore, not contain a security token. Additionally, by not making use of the CFB Security Offset area, the Client User ID and Client Password values are not eligible for being encrypted.

SecurityUsedEnhanced

Indicates to the runtime that the CLIENT_USER_ID, CLIENT_PASSWORD, and the optional Security Token should be added to the CFB by way of the CFB Security Offset. Additionally, at most (8) bytes of the Client User ID value will be set into the CFB header.

SecurityError

Indicates to the runtime that an error was encountered by the user exit and that the processing of the associated request has failed. The error indication and message string returned using the failureMsg argument would be returned to the proxy runtime. The proxy runtime will popup an error message display indicating the failed request.