Executing a RunStartUp Request - 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

Executing a RunStartUp Request

The user’s startup string is not automatically executed when a connection is established through CLIv2. Instead, the startup string is executed by issuing a RunStartUp request. The RunStartUp request can be issued at any time during the execution of the program.

The following information is presented as though the connection to Teradata Database is already established.

To run a startup string after the session is established, an application must perform the following steps:

1 Modify the DBCAREA.

a Set the Function to RunStartUp.

b Set the Input CLIv2 Session Id to the Output CLIv2 Session Id obtained when the session was established.

c Optionally set the following:

  • Request Buffer Length
  • Request‑parcel‑format
  • Response Buffer Length
  • Anticipated Number of Concurrent Sessions
  • Request‑token
  • Using Data Pointer
  • Using Data Length
  • Using‑data‑count
  • Using‑data‑length‑vector
  • Using‑data‑pointer‑vector
  • Data‑encryption
  • Message Area Pointer
  • Message Area Length
  • Any option values required (remember to set Change Options = Y if any option values are changed)
  • 2 Call DBCHCL to perform the RunStartUp function, then checks the return code from DBCHCL:

     

    Return Code.

    Result

    0

    Call DBCHCL to perform a Fetch function (see “Fetching the Response for a Request” on page 58) until the complete response has been processed.

    anything else

    Process the return code and DBCAREA message.

    3 Call DBCHCL to perform the End Request function (see “Ending a Request” on page 61).

    The runstartup string can contain either a macro requiring input parameters or a request with a USING row descriptor. In this situation, the application must pass the address and length of the data area to CLIv2. The Using Data Pointer and Using Data Length fields of the DBCAREA are provided for this purpose.