00001 /* 00002 MODULE NAME ctgclient.h 00003 00004 DESCRIPTIVE NAME CICS Transaction Gateway ECI Version 2.1 00005 Application Programming Interface 00006 00007 Service level: V8.0.0.1 00008 00009 Licensed Materials - Property of IBM 00010 00011 "Restricted Materials of IBM" 00012 00013 5724-I81 5725-B65 5655-W10 00014 00015 (c) Copyright IBM Corp. 2010 All Rights Reserved. 00016 00017 US Government Users Restricted Rights - Use, duplication or 00018 disclosure restricted by GSA ADP Schedule Contract with 00019 IBM Corp. 00020 00021 Status: Version 8 Release 0 00022 00023 00024 NOTES :- 00025 00026 This header file is provided with the CICS Transaction Gateway. This 00027 product is available for a number of different operating environments 00028 and to ensure the correct sections of this header are included, the 00029 following constants must be defined at compile time according to 00030 platform: 00031 00032 CICS_W32 - if building a Windows application 00033 CICS_AIX - if building an AIX application 00034 CICS_SOL - if building a Solaris application 00035 CICS_HPUX - if building an HPUX application 00036 CICS_LNX if building a Linux application 00037 CICS_HPIT and CICS_HPUX - 00038 if building an HPUX application on Itanium 00039 */ 00046 #ifndef _CTGCLIENT_H 00047 #define _CTGCLIENT_H 00048 00049 /* Include stddef.h for size_t type definition */ 00050 #include <stddef.h> 00051 00052 #if defined (CICS_W32) || defined(CICS_WNT) 00053 #define CICSCALL __cdecl 00054 #else 00055 #define CICSCALL 00056 #endif 00057 /*********************************************************************/ 00058 /* CICS TG ECI Version 2 General constants */ 00059 /*********************************************************************/ 00064 #define CTG_API_VERSION "2.1.0.0" 00065 00069 #define CTG_DLL_VERSION "8.0.0.1" 00070 00074 #define CTG_MAX_RCSTRING 40 00075 00077 #define CTG_NULL_GWTOK NULL 00078 00079 00080 00081 /*********************************************************************/ 00082 /* CICS TG ECI Version 2 Connection functions */ 00083 /*********************************************************************/ 00088 typedef struct _CTG_ConnToken_t * CTG_ConnToken_t; 00089 00126 int CICSCALL CTG_openRemoteGatewayConnection(char * address, 00127 int port, 00128 CTG_ConnToken_t * gwTokPtr, 00129 int connTimeout); 00130 00148 int CICSCALL CTG_closeGatewayConnection(CTG_ConnToken_t * gwTokPtr); 00149 00164 int CICSCALL CTG_closeAllGatewayConnections(); 00165 00166 00167 /*********************************************************************/ 00168 /* CICS TG ECI Version 2 Utility functions */ 00169 /*********************************************************************/ 00170 00192 int CICSCALL CTG_getAPITraceLevel(int * traceStatePtr); 00193 00223 int CICSCALL CTG_setAPITraceLevel(int traceState); 00224 00252 int CICSCALL CTG_setAPITraceFile(char * traceFileNamePtr); 00253 00270 void CICSCALL CTG_setAPITraceDataLength(size_t dataLength); 00271 00288 void CICSCALL CTG_setAPITraceDataOffset(size_t dataOffset); 00289 00304 int CICSCALL CTG_dumpState(); 00305 00314 char * CICSCALL CTG_getRcString(int returnCode, char * rcString); 00315 00330 int CICSCALL CTG_getAPIVersion(char ** apiVersPtr); 00331 00346 int CICSCALL CTG_getDLLVersion(char ** dllVersPtr); 00347 00348 /*****************************************************************************/ 00356 typedef struct 00357 { 00358 /* Length of SystemName */ 00359 #define CTG_LIST_SYSTEM_LENGTH 8 00360 00366 char SystemName[CTG_LIST_SYSTEM_LENGTH+1]; 00367 00368 /* Length of the Description */ 00369 #define CTG_LIST_DESCRIPTION_LENGTH 60 00370 00377 char Description[CTG_LIST_DESCRIPTION_LENGTH+1]; 00378 } CTG_listSystem_t; 00379 00380 /*****************************************************************************/ 00414 int CICSCALL CTG_listSystems(CTG_ConnToken_t gwTok, 00415 unsigned short *Systems, 00416 CTG_listSystem_t *List); 00417 00418 /*********************************************************************/ 00419 /* CICS TG ECI Version 2 Return Code constants */ 00420 /*********************************************************************/ 00424 #define CTG_OK 0 00425 00427 #define CTG_ERR_INVALID_DATA_LENGTH -1 00428 00430 #define CTG_ERR_SYSTEM_ERROR -9 00431 00433 #define CTG_ERR_MORE_SYSTEMS -25 00434 00436 #define CTG_ERR_NO_SYSTEMS -26 00437 00441 #define CTG_ERR_NULLGWTOK -100 00442 00447 #define CTG_ERR_BADGWTOK -101 00448 00451 #define CTG_ERR_LOSTGWCON -102 00452 00455 #define CTG_ERR_NULLPARM -103 00456 00459 #define CTG_ERR_TRACELEVEL -104 00460 00464 #define CTG_ERR_BADPORT -107 00465 00468 #define CTG_ERR_NULLGWTOKPTR -108 00469 00472 #define CTG_ERR_NULLPTR -109 00473 00477 #define CTG_ERR_MALLOCFAIL -111 00478 00481 #define CTG_ERR_BADGWTOKLIST -115 00482 00485 #define CTG_ERR_CONNECTFAILED -118 00486 00493 #define CTG_ERR_LOCKFAIL -121 00494 00501 #define CTG_ERR_PIDMISMATCH -123 00502 00505 #define CTG_ERR_TIDMISMATCH -124 00506 00509 #define CTG_ERR_TRACEFILE -130 00510 00513 #define CTG_ERR_BADHOST -132 00514 00517 #define CTG_ERR_NULLADDRESS -133 00518 00521 #define CTG_ERR_CONNECTTIMEOUT -134 00522 00525 #define CTG_ERR_NULLECIPOINTER -137 00526 00529 #define CTG_ERR_INVALIDTIMEOUTPARM -138 00530 00533 #define CTG_ERR_UNKNOWN_REQUEST_TYPE 0xF002 00534 00537 #define CTG_ERR_GATEWAY_CLOSED 0xF004 00538 00542 #define CTG_ERR_WORK_WAS_REFUSED 0xF005 00543 00546 #define CTG_ERR_GATEWAY_EXCEPTION 0xF006 00547 00555 #define CTG_ERR_GATEWAY_BACK_LEVEL 0xF00A 00556 00560 #define CTG_ERR_INVALID_REQUEST_TYPE 0xF00B 00561 00562 /*********************************************************************/ 00563 /* CICS TG ECI Version 2 Trace constants */ 00564 /*********************************************************************/ 00568 #define CTG_TRACE_LEVEL0 0 00569 00572 #define CTG_TRACE_LEVEL1 1 00573 00577 #define CTG_TRACE_LEVEL2 2 00578 00582 #define CTG_TRACE_LEVEL3 3 00583 00587 #define CTG_TRACE_LEVEL4 4 00588 00589 00590 #endif /* ifndef _CTGCLIENT_H */ 00591 00592 /* Doxygen index page */ 00593
© Copyright IBM Corporation 2006, 2010. All rights reserved.
For legal information, see http://www.ibm.com/legal/copytrade.shtml