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"
#include "eci_channel.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 54 of file ctgclient_eci.h.

#define ECI_ABEND_CODE_LENGTH   4
 

Definition at line 146 of file ctgclient_eci.h.

#define ECI_BACKOUT   4
 

Definition at line 194 of file ctgclient_eci.h.

#define ECI_COMMIT   2
 

Definition at line 193 of file ctgclient_eci.h.

#define ECI_ERR_CICS_DIED   -4
 

ECI return code, the specified server is no longer available.

Definition at line 448 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_CALL_TYPE   -14
 

ECI return code, the call type was not valid.

Definition at line 467 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_DATA_AREA   -19
 

ECI return code, the data area is not valid.

Definition at line 478 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_DATA_LENGTH   -1
 

ECI return code, bad data length.

Definition at line 438 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_EXTEND_MODE   -2
 

ECI return code, the extend mode field is not valid.

Definition at line 441 of file ctgclient_eci.h.

#define ECI_ERR_INVALID_VERSION   -21
 

ECI return code, the version is not valid.

Definition at line 481 of file ctgclient_eci.h.

#define ECI_ERR_LUW_TOKEN   -8
 

ECI return code, the value in Luw_Token is incorrect.

Definition at line 461 of file ctgclient_eci.h.

#define ECI_ERR_MAX_SESSIONS   -29
 

ECI return code, not enough communication resources to satisfy request.

Definition at line 496 of file ctgclient_eci.h.

#define ECI_ERR_MAX_SYSTEMS   -28
 

ECI return code, reached limit on maximum number of systems.

Definition at line 492 of file ctgclient_eci.h.

#define ECI_ERR_NO_CICS   -3
 

ECI return code, no CICS system is available.

Definition at line 444 of file ctgclient_eci.h.

#define ECI_ERR_NO_SESSIONS   -17
 

ECI return code, not enough communication resources to satisfy request.

Definition at line 475 of file ctgclient_eci.h.

#define ECI_ERR_REQUEST_TIMEOUT   -5
 

ECI return code, the value supplied for timeout is negative.

Definition at line 452 of file ctgclient_eci.h.

#define ECI_ERR_RESOURCE_SHORTAGE   -16
 

ECI return code, not enough resource to complete the request.

Definition at line 471 of file ctgclient_eci.h.

#define ECI_ERR_RESPONSE_TIMEOUT   -6
 

ECI return code, the ECI call timed out.

Definition at line 455 of file ctgclient_eci.h.

#define ECI_ERR_ROLLEDBACK   -30
 

ECI return code, an attempt was made to commit a logical unit of work, but the server was unable to commit the changes, and backed them out instead.

Definition at line 501 of file ctgclient_eci.h.

#define ECI_ERR_SECURITY_ERROR   -27
 

ECI return code, an invalid combination of user ID and password was specified.

Definition at line 488 of file ctgclient_eci.h.

#define ECI_ERR_SYSTEM_ERROR   -9
 

ECI return code, an internal system error has occurred.

Definition at line 464 of file ctgclient_eci.h.

#define ECI_ERR_TRANSACTION_ABEND   -7
 

ECI return code, the CICS transaction abended.

Definition at line 458 of file ctgclient_eci.h.

#define ECI_ERR_UNKNOWN_SERVER   -22
 

ECI return code, the requested server could not be located.

Definition at line 484 of file ctgclient_eci.h.

#define ECI_EXTENDED   1
 

Definition at line 192 of file ctgclient_eci.h.

#define ECI_LUW_NEW   0
 

Definition at line 252 of file ctgclient_eci.h.

#define ECI_NO_ERROR   0
 

ECI return code, no error.

Definition at line 435 of file ctgclient_eci.h.

#define ECI_NO_EXTEND   0
 

Definition at line 191 of file ctgclient_eci.h.

#define ECI_PASSWORD_LENGTH   16
 

Definition at line 119 of file ctgclient_eci.h.

#define ECI_PROGRAM_NAME_LENGTH   8
 

Definition at line 100 of file ctgclient_eci.h.

#define ECI_SYNC   1
 

Definition at line 92 of file ctgclient_eci.h.

#define ECI_SYSTEM_NAME_LENGTH   8
 

Definition at line 285 of file ctgclient_eci.h.

#define ECI_TPN_LENGTH   4
 

Definition at line 305 of file ctgclient_eci.h.

#define ECI_TRANSID_LENGTH   4
 

Definition at line 124 of file ctgclient_eci.h.

#define ECI_USERID_LENGTH   16
 

Definition at line 114 of file ctgclient_eci.h.

#define ECI_VERSION_2   4
 

Definition at line 278 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 347 of file ctgclient_eci.h.


Function Documentation

int CTG_ECI_dumpChannels  ) 
 

Writes the contents of internal CICS TG channel and container structures to the current trace destination.

The debug information is written irrespective of trace settings.

Note:
The IBM service organization may request that this function is used to aid problem determination.
Returns:
An integer value identifies whether the call was successful or not.
Possible values include

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.

int CTG_ECI_Execute_Channel CTG_ConnToken_t  gwTok,
CTG_ECI_PARMS EciParms
 

Sends an ECI request to the Gateway with a channel object.

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 2006, 2010. All rights reserved.
For legal information, see http://www.ibm.com/legal/copytrade.shtml