Previous Topic: PurposeNext Topic: Return Code


Arguments

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

Name

I/O

Description

*clientUserid

Input/Output

A pointer to a character array that contains the value of the proxy ClientUserid attribute. This user exit can set this value by modifying the data area pointed to by this argument. The value assigned by this user exit cannot exceed 64 bytes.

*clientPassword

Input/Output

A pointer to a character array that contains the value of the proxy ClientPassword attribute. This user exit can set this value by modifying the data area pointed to by this argument. The value assigned by this user exit cannot exceed 64 bytes.

*trancode

Input

A pointer to a character array that contains the trancode associated with the flow being processed by the proxy runtime synchronous or asynchronous cooperative flow operation.

*nextLocation

Input

A pointer to a character array that contains the Next Location variable associated with the flow being processed by the proxy runtime synchronous or asynchronous cooperative flow operation.

*bClntMgrSecurity

Output

A pointer to an integer Boolean field that can be set to either TRUE or FALSE. The value of this field only has meaning if this user exit returns SecurityUsedEnhanced. TRUE indicates that the security data (Client User ID and Client Password) that is added to the security offset of the associated CFB should be used as the source of the UserID and Password by the Client Manager or Communications Bridge.

*tokenLen

Input/Output

On input, tokenLen is a pointer to a long integer field that contains the maximum length of the allocated token character buffer. The maximum token length is dependent on the available space remaining during the construction of the CFB.

On return from the exit, the long integer pointed to by tokenLen should contain the actual length of data returned in the character array, which is pointed to by the token argument.

Note: The use of a token is optional, and therefore, setting the long integer pointed to by tokenLen to zero indicates that a token is not specified by the user exit. The length value returned by this field only has meaning if this user exit returns SecurityUsedEnhanced.

*token

Input/Output

On input, token is a pointer to a character array that will accept a user specified security token. The use of a user specified security token is optional. The token data that is provided by this user exit will be provided to the server side TIRSECV security user exit. The security token returned by this field only has meaning if this user exit returns SecurityUsedEnhanced.

*failureMsg

Input/Output

The pointer to an 80-character array that can receive a user provided null terminated error message string. The string pointed to by the failureMsg pointer will be incorporated into an error message that is displayed by the proxy runtime.