CICS_EpiAttributes_t

Purpose

The CICS_EpiAttributes_t structure holds information about the attributes to be associated with a terminal resource installed by the CICS_EpiAddExTerminal function.

Fields

EpiAddType
Indicates whether the application is prepared to wait until the request to install the terminal is complete. Use one of the following values:
CICS_EPI_ADD_ASYNC
The calling application gets control back when the request to install the terminal resource has been accepted; at this point the parameters have been validated.

Assuming valid parameters, the CICS_EPI_EVENT_ADD_TERM event is generated when the request to install the terminal has completed.

The TermIndex is returned for use with the CICS_EpiGetEvent function.

CICS_EPI_ADD_SYNC
The calling application gets control back when the request to install the terminal resource has completed. Returned information is immediately available.
InstallTimeOut
A value in the range 0 through 3600, specifying the maximum time in seconds that installation of the terminal resource is allowed to take; a value of 0 means that no limit is set.

A value of 3600 is assumed if a larger value is specified.

ReadTimeOut
A value in the range 0 through 3600, specifying the maximum time in seconds that is allowed between notification of a CICS_EPI_EVENT_CONVERSE event for the terminal resource and the following invocation of the CICS_EpiReply; a value of 0 means that no limit is set.

A value of 3600 is assumed if a larger value is specified.

If time-out occurs, the conversation is abended. This results in a CICS_EPI_EVENT_END_TRAN event being generated; the EndReason field is set to CICS_EPI_READTIMEOUT_EXPIRED; the AbendCode field is not set.

SignonCapability
Indicates whether the application may start server-provided sign-on and signoff transactions from the terminal resource. Use one of the following values:
CICS_EPI_SIGNON_CAPABLE
The terminal resource is to be installed as sign-on capable.
CICS_EPI_SIGNON_INCAPABLE
The resource is to be installed as sign-on incapable.
CCSId
A value in the range 1 through 65536 specifying the coded character set identifier (CCSID) that identifies the coded graphic character set used by the client application for data passed between the terminal resource and CICS® transactions.

A value of 0 means that a default CCSID is used.

For details on the CCSID values for various character sets see Data conversion when using the Client daemon, in the CICS Transaction Gateway: Administration book for your operating system.

UserId
A string specifying the userid to be associated with the terminal resource. If the userid is shorter than CICS_EPI_USERID_MAX, it must be padded with nulls to a length of CICS_EPI_USERID_MAX+1.
Password
A string specifying the password to be associated with the terminal resource. 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.