source/h/ctgclient_eci.h File Reference

Defines functions and typedefs for sending External Call Interface (ECI) requests to a Gateway daemon. More...

#include "ctgclient.h"

Go to the source code of this file.

Data Structures

Defines

Typedefs

Functions


Detailed Description

Defines functions and typedefs for sending External Call Interface (ECI) requests to a Gateway daemon.

Definition in file ctgclient_eci.h.


Define Documentation

#define CICSCALL
 

Definition at line 39 of file ctgclient_eci.h.

#define ECI_ABEND_CODE_LENGTH   4
 

Definition at line 163 of file ctgclient_eci.h.

#define ECI_ASYNC   2
 

Definition at line 76 of file ctgclient_eci.h.

#define ECI_BACKOUT   4
 

Definition at line 208 of file ctgclient_eci.h.

#define ECI_COMMIT   2
 

Definition at line 207 of file ctgclient_eci.h.

#define ECI_ERR_ALREADY_ACTIVE   -15
 

An attempt was made to continue an existing logical unit of work, but there was an outstanding asynchronous call for the same logical unit of work.

Definition at line 478 of file ctgclient_eci.h.

#define ECI_ERR_CICS_DIED   -4
 

Communication with the target CICS server was lost.

Definition at line 435 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_CALL_TYPE   -14
 

The eci_call_type value is not valid.

Definition at line 471 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_DATA_AREA   -19
 

The combination of eci_commarea and eci_commarea_length values is not valid.

If eci_commarea is NULL, eci_commarea_length must be zero. If eci_commarea is not NULL, eci_commarea_length must not be zero.

Definition at line 499 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_DATA_LENGTH   -1
 

Bad data length.

This might be because the protocol used to communicate with CICS is unable to send or receive the specified COMMAREA size.

Definition at line 420 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_EXTEND_MODE   -2
 

The eci_extend_mode value is not valid.

Definition at line 425 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_MSG_QUAL   -33
 

For ECI_GET_SPECIFIC_REPLY_WAIT calls this return code indicates that the message qualifier is not in use.

Definition at line 545 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_VERSION   -21
 

The eci_version value is not valid.

Definition at line 504 of file ctgclient_eci.h.

#define ECI_ERR_LUW_TOKEN   -8
 

The value in eci_luw_token is incorrect.

There is no active unit of work associated with the specified token.

Definition at line 459 of file ctgclient_eci.h.

#define ECI_ERR_MAX_SESSIONS   -29
 

There are insufficient communication resources to complete the request.

Definition at line 526 of file ctgclient_eci.h.

#define ECI_ERR_MAX_SYSTEMS   -28
 

The limit of the maximum number of connected CICS servers has been reached.

Definition at line 520 of file ctgclient_eci.h.

#define ECI_ERR_NO_CICS   -3
 

Communication with the target CICS server could not be established.

Definition at line 430 of file ctgclient_eci.h.

#define ECI_ERR_NO_REPLY   -32
 

For ECI_GET_REPLY calls this return code indicates that there are no replies outstanding.

For ECI_GET_SPECIFIC_REPLY calls this return code indicates that there is no reply for the specified message qualifier.

Definition at line 540 of file ctgclient_eci.h.

#define ECI_ERR_NO_SESSIONS   -17
 

There are insufficient communication resources to communicate with the target CICS server.

Definition at line 491 of file ctgclient_eci.h.

#define ECI_ERR_REQUEST_TIMEOUT   -5
 

The eci_timeout interval expired before the request was sent to CICS, or the timeout value is negative.

Definition at line 441 of file ctgclient_eci.h.

#define ECI_ERR_RESOURCE_SHORTAGE   -16
 

There are insufficient resources to communicate with the target CICS server; details might be available in the CICS TG error log files.

Definition at line 485 of file ctgclient_eci.h.

#define ECI_ERR_RESPONSE_TIMEOUT   -6
 

The eci_timeout interval expired while waiting for a response.

Definition at line 447 of file ctgclient_eci.h.

#define ECI_ERR_ROLLEDBACK   -30
 

An attempt was made to commit a logical unit of work, but the CICS server was unable to commit the changes and backed them out.

Definition at line 533 of file ctgclient_eci.h.

#define ECI_ERR_SECURITY_ERROR   -27
 

The combination of user ID and password is not valid.

Definition at line 514 of file ctgclient_eci.h.

#define ECI_ERR_SYSTEM_ERROR   -9
 

An internal system error has occurred.

If the problem persists, collect application and Gateway daemon trace and contact your IBM service representative.

Definition at line 466 of file ctgclient_eci.h.

#define ECI_ERR_TRANSACTION_ABEND   -7
 

The CICS transaction abended.

The abend code is available in the eci_abend_code field.

Definition at line 453 of file ctgclient_eci.h.

#define ECI_ERR_UNKNOWN_SERVER   -22
 

The target CICS server is unknown to the Gateway daemon.

Definition at line 509 of file ctgclient_eci.h.

#define ECI_EXTENDED   1
 

Definition at line 206 of file ctgclient_eci.h.

#define ECI_GET_REPLY   3
 

Definition at line 77 of file ctgclient_eci.h.

#define ECI_GET_REPLY_WAIT   4
 

Definition at line 78 of file ctgclient_eci.h.

#define ECI_GET_SPECIFIC_REPLY   5
 

Definition at line 79 of file ctgclient_eci.h.

#define ECI_GET_SPECIFIC_REPLY_WAIT   6
 

Definition at line 80 of file ctgclient_eci.h.

#define ECI_LUW_NEW   0
 

Definition at line 259 of file ctgclient_eci.h.

#define ECI_NO_ERROR   0
 

No error.

Definition at line 413 of file ctgclient_eci.h.

#define ECI_NO_EXTEND   0
 

Definition at line 205 of file ctgclient_eci.h.

#define ECI_PASSWORD_LENGTH   16
 

Definition at line 136 of file ctgclient_eci.h.

#define ECI_PROGRAM_NAME_LENGTH   8
 

Definition at line 116 of file ctgclient_eci.h.

#define ECI_SYNC   1
 

Definition at line 75 of file ctgclient_eci.h.

#define ECI_SYSTEM_NAME_LENGTH   8
 

Definition at line 298 of file ctgclient_eci.h.

#define ECI_TPN_LENGTH   4
 

Definition at line 316 of file ctgclient_eci.h.

#define ECI_TRANSID_LENGTH   4
 

Definition at line 142 of file ctgclient_eci.h.

#define ECI_USERID_LENGTH   16
 

Definition at line 130 of file ctgclient_eci.h.

#define ECI_VERSION_2   4
 

Definition at line 285 of file ctgclient_eci.h.

#define ECI_VERSION_S1   100
 

Definition at line 286 of file ctgclient_eci.h.


Typedef Documentation

typedef CTG_ECI_PARMS* PCTG_ECI_PARMS
 

A reference for an ECI Parameter block, CTG_ECI_Execute .

Definition at line 372 of file ctgclient_eci.h.


Function Documentation

int CTG_ECI_Execute CTG_ConnToken_t  gwTok,
CTG_ECI_PARMS EciParms
 

Sends an ECI request to the Gateway.

Equivalent to the flow() method of a com.ibm.ctg.client.JavaGateway object.

Parameters:
[in] gwTok The reference to the open Gateway connection.
EciParms The reference to the CTG_ECI_PARMS structure, the fields of the structure are used for input and output.
Returns:
An integer value identifies whether the call was successful or not.
Possible values include Other possible values are all of the documented ECI return codes.


© Copyright IBM Corporation 2011, 2012. All rights reserved.
For legal information, see http://www.ibm.com/legal/copytrade.shtml