Appendix A: Gateway-Library Quick Reference

This appendix contains Table A-1, which lists the Gateway-Library functions, shows the arguments used with each, and gives the function’s symbolic constants where used.

**Table A-1: Gateway-Library function quick reference**
Function	Arguments	Symbolic constants
TDACCEPT	(TDPROC,
	RETCODE,
	IHANDLE,
	ACCEPT-CONNECTION-NAME,
	ERROR-SUBCODE);
TDCONVRT	(TDPROC,
	RETCODE,
	NUM-DECIMAL-PLACES,
	SOURCE-TYPE,
	SOURCE-LENGTH,
	SOURCE-VARIABLE,
	RESULT-TYPE,
	RESULT-LENGTH,
	RESULT-VARIABLE,
	OUTLEN); Note: OUTLEN is optional.
TDCURPRO	(TDPROC,
	RETCODE,
	ACTION,
	CURSOR-DESC);
TDESCRIB	(TDPROC,
	RETCODE,
	COLUMN-NUMBER,
	HOST-VARIABLE-TYPE,
	HOST-VARIABLE-MAXLEN,
	HOST-VARIABLE-NAME,
	NULL-INDICATOR-VARIABLE,
	NULLS-ALLOWED,	TDS-TRUE TDS-FALSE
	COLUMN-TYPE,
	COLUMN-MAXLEN,
	COLUMN-NAME,
	COLUMN-NAME-LENGTH);
TDFREE	(TDPROC,
TDFREE	RETCODE);
TDGETREQ	(TDPROC,
	RETCODE,
	WAIT-OPTION,	TDS-TRUE TDS-FALSE
	REQUEST-TYPE,	TDS-LANGUAGE-EVENT TDS-RPC-EVENT TDS-DYNAMIC-EVENT TDS-CURSOR-EVENT
	TRAN-NAME);
TDGETSOI	(TDPROC,
	RETCODE,
	OBJECT-TYPE	TDS-OBJECT-COL TDS-OBJECT-PARM
	OBJECT-NUMBER
	STRIP-SOSI);	TDS-STRIP-SOSI TDS-BLANK-SOSI
TDGETUSR	(TDPROC,
	RETCODE,
	ACCESS-CODE,
	USER-ID,
	PASSWORD,
	SERVER-NAME,
	CLIENT-CHARSET,
	NATIONAL-LANGUAGE,
	SERVER-CHARSET,
	SERVER-DBCS,
	APPNAME-ID);
TDINFACT	(IHANDLE,
	RETCODE,
	ACCOUNTING-FLAG,	TDS-TRUE TDS-FALSE
	ACCOUNTING-FILENAME,
	MAXNUM-ACCT-RECORDS);
TDINFBCD	(TDPROC,
	RETCODE,
	OBJECT-TYPE,	TDS-OBJECT-COL TDS-OBJECT-PARM
	OBJECT-NUMBER,
	BCD-LENGTH,
	BCD-NUMBER-DECIMAL-PLACES);
TDINFLOG	(IHANDLE,
	RETCODE,
	GLOBAL-TRACE-FLAG,	TDS-NO-TRACING TDS-TRACE-ALL-RPCS TDS-TRACE-SPECIFIC-RPCS TDS-TRACE-ERRORS-ONLY
	API-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	TDS-HEADER-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	TDS-DATA-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	TRACE-ID,
	TRACE-FILENAME,
	MAXNUM-TRACE-RECORDS);
TDINFPGM	(TDPROC,
	RETCODE,
	TDS-VERSION,	TDS-VERSION2-3 TDS-VERSION3-4 TDS-VERSION4-0 TDS-VERSION4-2 TDS-VERSION4-6 TDS-VERSION4-8 TDS-VERSION4-9 TDS-VERSION5-0
	LONGVAR-TRUNC-FLAG,	TDS-TRUE TDS-FALSE
	ROW-LIMIT,
	REMOTE-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	USER-CORRELATOR,
	DB2GW-OPTIONS,
	DB2GW-PID,
	REQUEST-TYPE);	TDS-LANGUAGE-EVENT TDS-RPC-EVENT TDS-CURSOR-EVENT TDS-DYNAMIC-EVENT
TDINFPRM	(TDPROC,
	RETCODE,
	PARM-ID,
	DATATYPE,
	ACTUAL-DATA-LENGTH,
	MAX-DATA-LENGTH,
	PARM-STATUS,	For TDS 4.6: TDS-INPUT-VALUE TDS-RETURN-VALUE For TDS 5.0: TDS-INPUT-VALUE-NULLABLE TDS-RETURN-VALUE-NULLABLE
	PARM-NAME,
	PARM-NAME-LENGTH,
	USER-DATATYPE);
TDINFRPC	(TDPROC,
	RETCODE,
	REQUEST-TYPE,	TDS-LANGUAGE-EVENT TDS-RPC-EVENT TDS-CURSOR-EVENT TDS-DYNAMIC-EVENT
	REC-NAME,
	COMM-STATE);	TDS-RESET TDS-SEND TDS-RECEIVE
TDINFSPT	(IHANDLE,
	RETCODE,
	TRACE-STATUS,	TDS-TRUE TDS-FALSE
	TRACE-OPTION,	TDS-SPT-API-TRACE TDS-SPT-ERRLOG TDS-SPT-TDS-DATA
	TRANSACTION-ID,
	TRANSACTION-ID-LENGTH);
TDINFUDT	(TDPROC,
	RETCODE,
	COLUMN-NUMBER,
	USER-DATATYPE);
TDINIT	For CICS: (DFHEIBLK, For IMS TM: (IO-PCB,
	RETCODE,
	IHANDLE);
TDLOCPRM	(TDPROC,
	PARM-ID,
	PARM-NAME,
	PARM-NAME-LENGTH);
TDLSTSPT	(IHANDLE,
	RETCODE,
	TRACE-TABLE-LIST);
TDNUMPRM	(TDPROC,
TDNUMPRM	NUMBER-OF-PARMS);
TDRCVPRM	(TDPROC,
	RETCODE,
	PARM-ID,
	HOST-VARIABLE,
	HOST-VARIABLE-TYPE,
	MAX-DATA-LENGTH,
	ACTUAL-DATA-LENGTH);
TDRCVSQL	(TDPROC,
	RETCODE,
	HOST-VARIABLE,
	MAX-VAR-LENGTH,
	ACTUAL-STRING-LENGTH);
TDRESULT	(TDPROC,
TDRESULT	RETCODE);
TDSETACT	(IHANDLE,
	RETCODE,
	ACCOUNTING-FLAG,	TDS-TRUE TDS-FALSE
	ACCOUNTING-FILENAME,
	MAXNUM-ACCT-RECORDS);
TDSETBCD	(TDPROC,
	RETCODE,
	OBJECT-TYPE,	TDS-OBJECT-COL TDS-OBJECT-PARM
	OBJECT-NUMBER,
	BCD-LENGTH,
	BCD-NUMBER-DECIMAL-PLACES);
TDSETLEN	(TDPROC,
	RETCODE,
	COLUMN-NUMBER,
	NEW-COLUMN-LENGTH);
TDSETLOG	(IHANDLE,
	RETCODE,
	GLOBAL-TRACE-FLAG,	TDS-NO-TRACING TDS-TRACE-ALL-RPCS TDS-TRACE-SPECIFIC-RPCS TDS-TRACE-ERRORS-ONLY
	API-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	TDS-HEADER-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	TDS-DATA-TRACE-FLAG,	TDS-TRUE TDS-FALSE
	TRACE-ID
	TRACE-FILENAME
	MAXNUM-TRACE-RECORDS);
TDSETPRM	(TDPROC,
	RETCODE,
	PARM-ID,
	HOST-VARIABLE-TYPE,
	HOST-VARIABLE-LENGTH,
	HOST-VARIABLE,
	USER-DATATYPE);
TDSETPT	(IHANDLE,
	RETCODE,
	PROG-TYPE,	MPP BMP CONV EXPL
	SPA,
	RESERVED1,
	RESERVED2);
TDSETSOI	(TDPROC,
	RETCODE,
	OBJECT-TYPE,	TDS-OBJECT-COLUMN TDS-OBJECT-PARAMETER
	OBJECT-NUMBER,
	STRIP-SOSI);	TDS-STRIP-SOSI TDS-BLANK-SOSI
TDSETSPT	(IHANDLE,
	RETCODE,
	TRACE-STATUS,	TDS-TRUE TDS-FALSE
	TRACE-OPTIONS,	TDS-SPT-API-TRACE TDS-SPT-ERRLOG TDS-SPT-TDS-DATA
	TRANSACTION-ID,
	TRANSACTION-ID-LENGTH);
TDSETUDT	(TDPROC,
	RETCODE,
	COLUMN-NUMBER,
	USER-DATATYPE);
TDSNDDON	(TDPROC,
	RETCODE,
	STATUS,	TDS-DONE-FINAL TDS-DONE-CONTINUE TDS-DONE-ERROR TDS-DONE-COUNT
	ROW-COUNT,
	RETURN-STATUS-NUMBER,
	CONN-OPTIONS);	TDS-ENDREPLY TDS-ENDRPC TDS-FLUSH
TDSNDMSG	(TDPROC,
	RETCODE,
	MESSAGE-TYPE,	TDS-INFO-MSG TDS-ERROR-MSG
	MESSAGE-NUMBER,
	SEVERITY,	TDS-INFO-SEV TDS-ERROR-SEV
	ERROR-STATE,
	LINE-ID,
	TRANSACTION-ID,
	TRANSACTION-ID-LENGTH,
	MESSAGE-TEXT,
	MESSAGE-LENGTH);
TDSNDROW	(TDPROC,
TDSNDROW	RETCODE);
TDSQLLEN	(TDPROC,
TDSQLLEN	SQL-LENGTH);
TDSTATUS	(TDPROC,
	RETCODE,
	RETURN-STATUS-NUMBER,
	DONE-STATUS,	TDS-DONE-FINAL TDS-DONE-CONTINUE TDS-DONE-ERROR TDS-DONE-COUNT
	DONE-COUNT,
	COMM-STATE,	TDS-RESET TDS-SEND TDS-RECEIVE
	COMM-RETCODE,
	COMM-ERROR-SUBCODE);
TDTERM	(IHANDLE,
TDTERM	RETCODE);
TDYNAMIC	TDPROC,
	RETCODE,	TDS-DYN-TYPE TDS-DYN-IDLEN TDS-DYN-ID TDS-DYN-STMTLEN TDS-DYN-STMT
	CMD,
	ITEM,
	HOST-VARIABLE,
	HOST-VAR-LENGTH,
	ACTUAL-DATA-LENGTH
TDWRTLOG	(TDPROC,
	RETCODE,
	DATETIME-FLAG,	TDS-TRUE TDS-FALSE
	MESSAGE,
	MESSAGE-LENGTH);