Previous Topic: PurposeNext Topic: Return Code


Arguments

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

Name

I/O

Description

*trancode

Input

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

*nextLocation

Input

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

*clientUserid

Input

A pointer to a character array that contains the value of the of the CLIENT_USER_ID variable associated with the flow being processed by the proxy runtime synchronous or asynchronous cooperative flow processing. The CLIENT_USESRID variable is optionally set by Action Language coded within the C Proxy code.

MaxViewLen

Input

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

*encryptViewLen

Input/Output

A pointer to a long field. On input, EncryptViewLen is the length of the current buffer space (in bytes) of the data eligible for being encrypted. On output, EncryptViewLen should be updated to contain the length of the encrypted data. The length of the encrypted result cannot exceed maxViewLen.

*encryptView

Input/Output

A character pointer to the starting location of the data eligible for being encrypted. The encrypted data must be copied to this same memory location.

*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.