Output Fields - Call-Level Interface Version 2

Teradata Call-Level Interface Version 2 Reference for Mainframe-Attached Systems

Product
Call-Level Interface Version 2
Release Number
15.00
Language
English (United States)
Last Update
2018-09-28
dita:id
B035-2417
lifecycle
previous
Product Category
Teradata Tools and Utilities

Output Fields

The output fields are used by CLIv2 to provide the return code from the action requested and to pass back information from CLIv2 (for example, a pointer to a parcel in the response). Include files, which define this area, are provided for the supported languages, which are any language that supports standard IBM call linkage.

Note: Some fields are treated differently in different functions and by different clients.

 

Table 2: Order of the DBCAREA 

Byte Offset
(in decimal)

000

001

002

003

000

 

Eyecatcher, 8 bytes

 

004

 

 

 

 

008

 

Total Length, 4 bytes

 

012

 

Function, 4 bytes

 

016

 

Input CLIv2 Connection Id, 4 bytes

 

020

 

Input CLIv2 Request Id, 4 bytes

 

024

 

Request Buffer Length, 4 bytes

 

028

 

Response Buffer Length, 4 bytes

 

032

Anticipated Number of Concurrent Sessions, 4 bytes

036

Request‑token, 4 bytes

040

 

Return Code, 4 bytes

 

044

 

Output CLIv2 Connection Id, 4 bytes

 

048

 

Output CLIv2 Request Id, 4 bytes

 

052

 

Output TDP Path, 8 bytes

 

056

 

 

 

060

 

Output TDP Session Id, 4 bytes

 

064

Output Host Id, 2 bytes

Session Status,
1 byte

Unused, 1 byte

068

 

TDP Request Number, 4 bytes

 

072

 

Current Request Buffer Length, 4 bytes

 

076

 

Current Response Buffer Length, 4 bytes

 

080

 

Input TDP Path, 8 bytes

 

084

 

 

 

088

 

Logon Pointer, 4 bytes

 

092

 

Logon Length, 4 bytes

 

096

 

Run Pointer, 4 bytes

 

100

 

Run Length, 4 bytes

 

104

 

Request Pointer, 4 bytes

 

108

 

Request Length, 4 bytes

 

112

 

Using Data Pointer, 4 bytes

 

116

 

Using Data Length, 4 bytes

 

120

 

124

 

Reserved for internal use, 10 bytes

128

 

 

Unused, 2 bytes

132

Open Request, 4 bytes

136

Fetch Maximum Data Length, 4 bytes

140

Fetch Data Pointer, 4 bytes

144

Fetch Returned Data Length, 4 bytes

148

Fetch Parcel Flavor, 4 bytes

152

 

Unused, 4 bytes

 

156

 

TDP‑receipt‑timestamp, 8 bytes

 

160

 

 

 

 

164

 

Time1, 4 bytes

 

168

 

Time2, 4 bytes

 

172

Time3, 4 bytes

176

Time4, 4 bytes

180

Time5, 4 bytes

184

Character Set Pointer, 4 bytes

188

 

(reserved for network use, 8 bytes)

 

192

 

 

 

 

196

 

 

 

 

200

 

Unused, 16 bytes

 

204

 

 

 

 

208

 

 

 

 

212

Extension Pointer, 4 bytes

216

Change Options,
1 byte

Response Mode,
1 byte

Use Presence Bits,
1 byte

Keep Response,
1 byte

220

Wait‑during‑delay,
1 byte

Tell‑if‑delay,
1 byte

Reserved for network use, 1 byte

Locate Mode,
1 byte

224

Variable Length
Request, 1 byte

Variable Length
Fetch, 1 byte

Save Response
Buffer, 1 byte

Two Response,
Buffers, 1 byte

228

Return Time,
1 byte

Parcel Mode Fetch,
1 byte

Wait for Response,
1 byte

Request Processing
Option, 1 byte

232

Reserved for network use, 1 byte

Set Character Set,
1 byte

Connect Type,
1 byte

Request Mode,
1 byte

236

2PC,
1 byte

Protocol‑Function,
1 byte

Transaction Semantics,1 byte

Language Conformance, 1 byte

240

Unused, 2 byte

Message Text Length, 2 bytes

244

 

 

 

 

|.....|

 

Message Text, 76 bytes

 

316

 

 

 

 

320

Route Description Codes, 4 bytes

324

 

Unused, 4 bytes

 

328

 

Reserved for internal use, 4 bytes

 

332

 

Unused, 8 bytes

 

336

 

 

 

 

340

C2S Conversion,
1byte

S2C Conversion,
1 byte

Date Form,
1 byte

Maximum
Parcel, 1 byte

344

Language Id, 2 bytes

Country Id, 2 bytes

348

Segment Data, 1byte

Return‑objects‑as,
1 byte

Continued‑data,
1 bytes

Data‑encryption,
1 byte

352

Request‑parcel‑format, 1 byte

Statement‑status,
1 byte

Continued‑characters‑state,
1 byte

APH‑response‑OK, 1 byte

356

Return‑statement‑info

Return‑identity‑data

Positioning‑statement‑number, 2 bytes

360

 

Positioning‑value, 8 bytes

 

364

 

 

 

 

368

Positioning‑action, 2 bytes

Timing‑precision, 2 bytes

372

Level, 1 byte

Message Charset Used, 1 byte

Message Return Code, 2 bytes

376

Message Length, 2 bytes

Message Area Length, 2 bytes

380

Message Area Pointer, 4 bytes

When the Level field is not binary '0', the following fields are also present:

 

Table 3: Order of the Enlarged DBCAREA When Level > 0 

Byte Offset
(in decimal)

000

001

002

003

384

 

 

 

 

|....|

 

Unused, 148 bytes

 

532

Unused, 1 byte

Time1‑status, 1 byte

Time2‑status, 1 byte

Time3‑status, 1 byte

536

Time4‑status, 1 byte

Time5‑status, 1 byte

Wait‑exclusion,
1 byte

Use‑default‑conn, 1 byte

540

 

Using‑data‑count, 4 bytes

 

544

Mechanism‑name, 8 bytes

548

 

 

 

 

552

Unused, 4 bytes

556

 

Mechanism‑data‑ptr, 4 bytes

 

560

Mechanism‑data‑len, 4 bytes

564

Mechanism‑data‑encoding, 1byte

Result‑sets‑OK,
1 byte

Return‑result‑sets‑to, 1 byte

Delegate‑user‑identity, 1 byte

568

Unused, 4 bytes

572

Using‑data‑pointer‑vector, 4bytes

576

Unused, 4 bytes

580

Using‑data‑length‑vector, 4 bytes

584

Max‑decimal‑returned, 2 bytes

Transforms‑off
1 byte

Period‑as‑Struct
1 byte

588

Workload‑length, 4 bytes

592

Unused, 4 bytes

596

Workload‑pointer, 4 bytes

600

Unused, 4 bytes

604

Session‑desc‑pointer, 4 bytes

608

Session‑desc‑length, 4 bytes

612

Trusted‑request
1 byte

Column‑info
1 byte

Utility‑workload
1 byte

Multi‑statement‑errors 1 byte

616

Row‑count, 4 bytes

620

Automatic Redrive, 1 byte

Extended‑load, 1 byte

Unused, 2 bytes

624

Unused, 8 bytes

632

Position Stmt Number, 4 bytes

636

Unused, 1 byte

XML‑response‑format, 1 byte

Array Transforms Off, 1 byte

Refresh‑cached‑data, 1 byte