CICS_EpiSetSecurity

The CICS_EpiSetSecurity function allows a client application to specify a user ID and password to be associated with a terminal resource previously installed as sign-on incapable.

The CICS_EpiSetSecurity function can be invoked at any time; the user ID and password will be used as further transactions are started for the terminal resource. A CICS® Transaction Gateway determined user ID and password will be used if the function either has not been invoked for the terminal resource or has been invoked and has set the user ID, and by implication the password, to nulls.

Note that the client application is responsible for verifying the user ID and password.

Parameters

TermIndex: The terminal index of the terminal.
The EPI uses this parameter only for input.
UserId: A pointer to a null-terminated string that specifies the user ID. If the user ID is shorter than CICS_EPI_USERID_MAX characters, it must be padded with nulls to a length of CICS_EPI_USERID_MAX+1.
The EPI uses this parameter only for input.
Password: A pointer to a null-terminated string that specifies the password. If the password is shorter than CICS_EPI_PASSWORD_MAX characters, it must be padded with nulls to a length of CICS_EPI_PASSWORD_MAX+1.
The EPI uses this parameter only for input.

Return codes

CICS_EPI_ERR_BAD_INDEX: The TermIndex value is not a valid terminal index.
CICS_EPI_ERR_NOT_INIT: CICS_EpiInitialize has not been executed.
CICS_EPI_ERR_IN_CALLBACK: The function was called from a callback routine.
CICS_EPI_ERR_SYSTEM_ERROR: An internal system error occurred.
CICS_EPI_ERR_VERSION: The function is not supported for the version at which the EPI was initialized.
CICS_EPI_ERR_NULL_PASSWORD: Password was a null pointer.
CICS_EPI_ERR_NULL_USERID: Userid was a null pointer.
CICS_EPI_ERR_PASSWORD_INVALID: The length of the password exceeds CICS_EPI_PASSWORD_MAX.
CICS_EPI_ERR_USERID_INVALID: The length of the user ID exceeds CICS_EPI_USERID_MAX.
CICS_EPI_NORMAL: The function completed successfully.