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.
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);
|
||
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, |
|
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, |
|
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, |
|
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, |
|
RETCODE); |
||
TDSQLLEN |
(TDPROC, |
|
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, |
|
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); |