15.10 - DBCACNX Field Descriptions - Call-Level Interface Version 2

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

prodname
Call-Level Interface Version 2
vrm_release
15.10
category
Programming Reference
featnum
B035-2417-035K

The DBCACNX consists of two logical sections:

  • Header
  • Element
  • One header always exists and is followed by one or more elements. If data is associated with an element, it may either be included with the element or pointed to by the element. More than one extension may be chained together.

    Figure 10 lists the sequential order of the header fields. Figure 11 lists the sequential order of the element fields.

    Figure 10: DBCACNX Header Fields

    When the Level field contains a value of '2', there is an additional header field as shown below:

    New development should use only the level 2 form. The level 1 form is deprecated.

    Figure 11: DBCACNX Element Fields When Level = 2

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

    Data‑length

    Data‑length is a four-byte unsigned integer field into which the length of the data is placed. If no data is associated with this type, the field is zero.

     

     

    The variable name for Data‑length is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCEDLN

    DBXCEDLN

    PL/I

    D8XCEDLN

    DBXCEDLN

    C

    d8xcedLn

    dbxcedLn

    IBM Assembler

    D8XCEDLN

    DBXCEDLN

     

    This routine...

    Does this for Data‑length. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Data‑length is used by...

    To...

    applications

    write

    Note: If the length of an element would exceed 65535 (32767 for PL/I), then the data may not be part of the element and Data‑pointer must be used to address the data.

    Data‑pointer

    Data‑pointer is a four-byte field into which the pointer to the data is placed. If either there is no data associated with this type or the data is included in the element, the field is zero or null.

     

     

    The variable name for Data‑pointer is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCEDPT

    DBXCEDPT

    PL/I

    D8XCEDPT

    DBXCEDPT

    C

    d8xcedPt

    dbxcedPt

    IBM Assembler

    D8XCEDPT

    DBXCEDPT

     

    This routine...

    Does this for Data‑pointer. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Data‑pointer is used by...

    To...

    applications

    write

    Data‑type

    Data‑type is a two-byte unsigned integer field into which the type of data is placed.

     

     

    The variable name for Data‑type is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCEDTY

    DBXCEDTY

    PL/I

    D8XCEDTY

    DBXCEDTY

    C

    d8xcedTy

    dbxcedTy

    IBM Assembler

    D8XCEDTY

    DBXCEDTY

     

    This routine...

    Does this for Data‑type. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Data‑type is used by...

    To...

    applications

    write

    The following types are supported:

  • 1 for Client Userid (mnemonic DBXCEDTU)
  • 2 for Client Password (mnemonic DBXCEDTP)
  • 3 for Client Domain (mnemonic DBXCEDTD)
  • Element‑length

    Element‑length is a two-byte unsigned integer field into which the length of the element is placed.

     

     

    The variable name for Element‑length is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCLLEN

    DBXCLLEN

    PL/I

    DB8XCLLEN

    DBXCLLEN

    C

    d8xclLen

    dbxclLen

    IBM Assembler

    D8XCLLEN

    DBXCLLEN

     

    This routine...

    Does this for Element‑length. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Element‑length is used by...

    To...

    applications

    write

    Element‑type

    Element‑type is a two-byte unsigned integer field into which the type of element is placed. Currently, there is only one type of element, a data element with a type of 0.

     

     

    The variable name for Element‑type is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCLTYP

    DBXCLTYP

    PL/I

    D8XCLTYP

    DBXCLTYP

    C

    d8xclTyp

    dbxclTyp

    IBM Assembler

    D8XCLTYP

    DBXCLTYP

     

    This routine...

    Does this for Element‑type. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Element‑type is used by...

    To...

    applications

    write

    The mnemonic DBXCETD should be used to define a data element.

    Eyecatcher

    Eyecatcher is a four-byte field into which the EBCDIC characters 'CNX ' must be placed.

     

     

    The variable name for Eyecatcher is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCID

    DBXCID

    PL/I

    D8XCID

    DBXCID

    C

    d8xcId

    dbxcId

    IBM Assembler

    D8XCID

    DBXCID

     

    This routine...

    Does this for Eyecatcher. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Eyecatcher is used by...

    To...

    applications

    write

    The mnemonic DBXCICNX contains 'CNX ' and should be used to initialize this field.

    Length

    Length is a four-byte unsigned integer field into which the total length of the extension is placed. The length includes the header fields, the fields of all elements, and any in-line data for the elements.

     

     

    The variable name for Length is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCLEN

    DBXCLEN

    PL/I

    D8XCLEN

    DBXCLEN

    C

    d8xcLen

    dbxcLen

    IBM Assembler

    D8XCLEN

    DBXCLEN

     

    This routine...

    Does this for Length. . .1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Length is used by...

    To...

    applications

    write

    Level

    The Level field specifies the format of the extension. The current level is 2. New development should use only the level 2 form. The level 1 form is deprecated.

     

     

    The variable name for Level is...

    In this language...

    Level 2

    Level 1

    COBOL

    D8XCLVL

    DBXCLVL

    PL/I

    D8XCLVL

    DBXCLVL

    C

    d8xcLvl

    dbxcLvl

    IBM Assembler

    D8XCLVL

    DBXCLVL

     

    This routine...

    Does this for Level...1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Level is used by...

    To...

    applications

    write

    The mnemonic DBXCLVLC should be used to initialize this field.

    Next‑pointer

    Next‑pointer is a four-byte field into which the pointer to the next Connect‑extension is placed. If another Connect‑extension does not exist, the field is zero or null.

     

     

    The variable name for Next‑pointer is...

    In this language...

    Level 2

    Level 1

    COBOL

    D4XCNEXT

    DBXCNEXT

    PL/I

    D4XCNEXT

    DBXCNEXT

    C

    d4xcNext

    dbxcNext

    IBM Assembler

    D4XCNEXT

    DBXCNEXT

     

    This routine...

    Does this for Next‑pointer...1

    DBCHINI

    DBCHCL

    reads (CON)


    1
    An en dash (–) means unavailable or not applicable.

     

    Next‑pointer is used by...

    To...

    applications

    write