This topic lists the parameters of the CICS_ExternalCall function.
- ECI_Parms
- A pointer to the ECI parameter block. Set the parameter block
to nulls before use. The parameter block fields that are used
as input and output are described in detail for each call type in
the following sections. A brief summary of the fields follows:
- eci_abend_code
- Abend code for a failed program.
- eci_callback
- A pointer to a callback routine for an asynchronous request. Not
supported in COBOL applications.
- eci_call_type
- An integer field defining the type of call being made.
- eci_commarea
- A COMMAREA for use by a called program, or for returned status
information.
- eci_commarea_length
- The length of the COMMAREA. The size of the COMMAREA must be set
to the largest size of the input or output data. This length must
not exceed 32,500 bytes. If the input data is less than the length
of the COMMAREA, pad the COMMAREA with nulls. The Client daemon strips
off the null padding and sends only the data on the ECI request to
the CICS® server.
- eci_extend_mode
- Used to manage logical units of work that span multiple ECI requests.
See Managing logical units of work
for more details.
- eci_luw_token
- An identifier for a logical unit of work.
- eci_message_qualifier
- A user-provided reference to an asynchronous call.
- eci_password
- Password for security checking.
- eci_password2
- Password for security checking. This is used if the
password is more than 8 characters.
- eci_program_name
- The name of a program to be called.
- eci_sysid
- Reserved for future use; leave null.
- eci_system_name
- The name of a CICS server.
- eci_timeout
- The time to wait for a response from the CICS server.
For more information on the ECI time-out support, see Timeout of the ECI request.
For remote mode IPIC, this value can be overridden by the ECITIMEOUT
property on the IPIC server definition.
- eci_tpn
- A transaction identifier for the mirror transaction.
- eci_transid
- A transaction identifier.
- eci_userid
- User ID for security checking.
- eci_userid2
- User ID for security checking. This is used if the
User ID is more than 8 characters.
- eci_version
- The version of the ECI for which the application is coded. Use
the value ECI_VERSION_1A.
- reserved1
- This field was previously eci_system_return_code. In Version
3.1 and higher of the product, this field is kept for compatibility.
No information is returned in this field; all system errors are written
to the CICS Transaction Gateway's
error log.