Connect extension (DBCACNX) - Call-Level Interface Version 2

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

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

Connect extension (DBCACNX)

Usage Notes

The DBCACNX extension applies only to the Connect function and only when the Connect-type option specifies a combined logon and connect. Use of the Connection-extension will be rejected if the Connect-type option specifies a separate logon and run. When used, it should be pointed to by the Extension Pointer DBCAREA field before invoking Connect. The Extension Pointer should be zeroed after the Connect function to prevent subsequent functions from attempting to use it.

Note: The DBCACNX can be used only to provide information required by CLI for third party Logon (SSO). Third party logon is supported only on Windows.

DBCACNX Fields

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.

    Header

    Level should be set to 2.

    A structure DBCACNX is defined in the dbcacnx.h file with the above format.

    DBCACNX Element Fields when Level is set to 2.

    Structures 'D8XCELEM' and ‘D8XCED’ are defined in the dbcacnx.h file with the above format.

    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.

     

    Structure

    Member Name

    D8XCED

    d8xcedLn

    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.

     

    Structure

    Member Name

    D8XCED

    d8xcedPt

    Data-type

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

     

    Structure

    Member Name

    D8XCED

    d8xcedTy

    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.

     

    Structure

    Member Name

    D8XCELEM

    d8xceLen

    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.

     

    Structure

    Member Name

    D8XCELEM

    d8xceTyp

    Eyecatcher

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

     

    Structure

    Member Name

    D8CACNX

    d8xcId

    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.

     

    Structure

    Member Name

    D8CACNX
    d8xcLen

    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.

     

    Structure

    Member Name

    D8CACNX
    d8xcLvl

    Next-pointer

    Next-pointer is a four-byte (32-bit) or an eight-byte (64-bit) 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.

     

    Structure

    Member Name

    D8CACNX
    d8xcNext