16.20 - DBCAIRX Fields - Teradata Tools and Utilities

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

prodname
Teradata Tools and Utilities
vrm_release
16.20
created_date
September 2019
category
Programming Reference
featnum
B035-2417-108K

The sections that follow describe each of the fields in DBCAIRX. The fields are given in alphabetical order.

Data Address

The Data Address field specifies the address of the parcel body. The symbolic name depends upon the Eyecatcher field.

  The variable name for Data Address is...
In this language... IRX8 IRX & DBCX
COBOL D8XILPPT DBXILPPT
PL/I D8XILPPT DBXILPPT
C d8xilpPt dbxilpPt
IBM Assembler D8XILPPT DBXILPPT
This routine... Does this for Data Address...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Data Address is used by... To...
applications write

Data Length

When the Eyecatcher is ‘IRX‘ or ‘DBCX‘ the Data Length field specifies the length of the parcel body addressed by the Data Address field.

The minimum value is 0 and:

The maximum value is... If Maximum-parcel is set to...
32763 O
65531 H
In this language... The variable name for Data Length is...
COBOL DBXILPLN
PL/I DBXILPLN
C dbxilpLn
IBM Assembler DBXILPLN
This routine... Does this for Data Length...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Data Length is used by... To...
applications write

Data Size

When the Eyecatcher is 'IRX8' the Data Size field specifies the length of the parcel body addressed by the Data Address field.

The minimum value is 0 and:

The maximum value is... If Maximum-parcel is set to...
32763 O
65531 H

The symbolic name depends upon both the Eyecatcher and Level fields:

  The variable name for Data Size is...
In this language... IRX8 and Level 0 IRX8 and Level 1
COBOL D8XILPLN D8XIEPLN
PL/I D8XILPLN D8XIEPLN
C d8xilpLn d8xiepLn
IBM Assembler D8XILPLN D8XIEPLN
This routine... Does this for Data Size...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Data Size is used by... To...
applications write

Element Length

Element Length contains the length of the individual element.

The maximum value is... If Maximum-parcel is set to...
32767 O
65535 H

The symbolic name depends upon the Eyecatcher field.

  The variable name for Element Length is...
In this language... IRX8 IRX & DBCX
COBOL D8XILLEN DBXILLEN
PL/I D8XILLEN DBXILLEN
C d8xilLen dbxilLen
IBM Assembler D8XILLEN DBXILLEN
This routine... Does this for Element Length...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Element Length is used by... To...
applications write

Element Type

When the Eyecatcher field contains 'IRX8' and the Level field contains '1', Element Type indicates the type of element; currently only a Parcel element is supported and is indicated by an Element Type of '1' (mnemonic of 'D8XIETP' in all languages).

When either the Eyecatcher field contains 'IRX8' and the Level field contains '0', the Eyecatcher field contains 'IRX', or the Eyecatcher field contains 'DBCX', the Element Type not only indicates whether the parcel data is in the element or simply addressed by the element, but also specifies the parcel flavor. If the leftmost bit is zero, then the parcel body is contained in the element itself; if this bit is one, then the parcel body is addressed by the element. The remainder of the field contains the parcel flavor.

The symbolic name depends upon both the Eyecatcher and Level fields:

  The variable name for Element Type is...
In this language... IRX8 and Level 0 IRX8 and Level 1 IRX & DBCX
COBOL D8XILTYP D8XIETYP DBXILTYP
PL/I D8XILTYP D8XIETYP DBXILTYP
C d8xilTyp d8xieTyp dbxilTyp
IBM Assembler D8XILTYP D8XIETYP DBXILTYP
This routine... Does this for Element Type...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Element Type is used by... To...
applications write

A mnemonic is provided for the high-order bit and should be used. The symbolic name depends upon the Eyecatcher field. The name is the same for all languages, including C. For 'IRX' and 'DBCX' the name is DBXILTP. For 'IRX8' the name is D8BXILTP.

Any value in Element Type greater than 4095 gives a nonzero return code. Any value in Element Type less than 4096 and not a valid parcel flavor will result in an error being returned from the Teradata Database.

If the high-order bit is off in Element Type, the element data contains a parcel body. However, if the high-order bit is on in Element Type, the element data contains a pointer to the actual parcel body and the length of the pointed to parcel body. Element Length in this case always contains 10.

Eyecatcher

Eyecatcher in the DBCAIRX is used for self-documentation, validation, and debugging. The symbolic name depends upon the Eyecatcher field.

  The variable name is...
In this language. . . for Eyecatcher and ‘IRX8‘ for Eyecatcher and ‘IRX‘ or ‘DBCX‘
IBM Assembler, COBOL, or PL/I D8XIID DBXIID
C d8xiId dbxiId
This routine... Does this for Eyecatcher...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Eyecatcher is used by... To...
applications write

Eyecatcher is set to 'IRX8', 'IRX', or 'DBCX' by the application before calling DBCHCL for the Initiate Request function.

Apostrophes are not used in Eyecatcher.

New development should use only the 'IRX8' form. The others are deprecated.

Level

When the Eyecatcher is 'IRX8', the Level field specifies the format of the extension.

In this language... The variable name for Level is...
IBM Assembler, COBOL, or PL/I D8XCLVL
C d8xcLvl
This routine... Does this for Level...
DBCHINI
DBCHCL reads (CON)
A dash (–) means unavailable or not applicable.
Level is used by... To...
applications write

Level must be set to one of the following 1-byte unsigned integer values before calling a DBCHCL function, the first choice is the current level and should be used by all new development.

Value Mnemonic
1
  • D8XILERS for COBOL
  • D8XILELS for PL/I
  • D8XILERS for C and C++
  • D8XILERS for Assembler
0
  • D8XIL64 for COBOL
  • D8XIL64 for PL/I
  • D8XIL64 for C and C++
  • D8XIL64 for Assembler

Next Pointer

If nonzero, Next Pointer points to another DBCAIRX to form a linked list of DBCAIRX extensions. For implicit Connects, Connect extensions (DBCACNX) may also be included. The symbolic name depends upon the Eyecatcher field.

  The variable name for Next Pointer is...
In this language... IRX8 IRX & DBCX
IBM Assembler, COBOL, or PL/I D8XINEXT DBXINEXT
C d8xiNext dbxiNext
This routine... Does this for Next Pointer...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Next Pointer is used by... To...
applications write

The sequence in which the DBCAIRX extensions are linked is the same sequence in which the parcels contained in DBCAIRXs are built in the request buffer.

If there is only one DBCAIRX, or if this is the last DBCAIRX in the linked list, then set Next Pointer to zero or PL/I null pointer.

Parcel Flavor

The Parcel Flavor field specifies the flavor of the parcel. Values greater than 32767 are rejected by CLIv2; values that are not valid for the Teradata Database being used will be rejected by the Database.

In this language... The variable name for Parcel Flavor is...
IBM Assembler, COBOL, or PL/I D8XIEPF
C d8xiePF
This routine... Does this for Parcel Flavor...
DBCHCL reads (IRQ; IWPF)

Total-length

If ‘DBCX‘ was specified in Eyecatcher, Total-length specifies the length of one DBCAIRX in bytes.

In this language... The variable name for Total-length is...
IBM Assembler, COBOL, or PL/I DBXILEN
C dbxiLen
This routine... Does this for Total-length...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Total-length is used by... To...
applications write

Total-length must be set by the application before calling DBCHCL. This length is validated against the sum of the lengths of the individual elements in the DBCAIRX plus the header. If it is not correct, the Teradata Database sends a nonzero return code.

Total Size

If ‘IRX8 or IRX‘ was specified in Eyecatcher, Total Size specifies the length of one DBCAIRX in bytes.

  The variable name for Total Size is...
In this language... IRX8 IRX
IBM Assembler, COBOL, or PL/I D8XISIZE DBXISIZE
C d8xiSize dbxiSize
This routine... Does this for Total Size...
DBCHINI
DBCHCL reads (IRQ; IWPF)
A dash (–) means unavailable or not applicable.
Total Size is used by... To...
applications write

Total Size must be set by the application before calling DBCHCL. This size is validated against the sum of the sizes of the individual elements in the DBCAIRX plus the header. If it is not correct, the Teradata Database sends a nonzero return code.