15.10 - Locate Mode - 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

Locate Mode is a one-byte field that specifies where the data returned is to be made available.

 

In this language...

The variable name for Locate Mode is...

COBOL

DBCAREA‑LOC‑MODE

PL/I

LOC_MODE

C

loc_mode

IBM Assembler

DBOFLOC

 

This routine...

Does this for Locate Mode...

DBCHINI

writes

DBCHCL

reads (CON; RSUP; IRQ; CMD; CRQ)

 

Locate Mode is used by...

To...

applications

write.

Locate Mode is initialized by DBCHINI to the default value provided for Locate Mode in the HSHSPB. When the value for Locate Mode is not appropriate for an application, perform the following procedure before calling DBCHCL for Connect, RunStartUp, Command, or Initiate Request functions:

1 Set Change Options to 'Y'.

2 Change the value for Locate Mode as follows.

 

If the data returned is to be...

Then change the value for Locate Mode to...

made available in the response buffer

Y

made available in the move area

N

Use mnemonics for the codes. Mnemonics are provided in the language definition file for the DBCAREA.

Within this manual, the following conventions apply:

  • Locate Mode of Y is known as Locate Mode.
  • Locate Mode of N with Parcel Mode Fetch of Y is known as Move Mode.
  • Locate Mode operates in conjunction with Parcel Mode Fetch. The setting of Locate Mode affects the use of Fetch Maximum Data Length, Fetch Data Pointer, Fetch Returned Data Length, and Fetch Parcel Flavor.

    Note: Variable Length Fetch and Locate Mode can be set to 'Y' at the same time.

    When using Locate mode, applications should not change the data whose pointer is returned. This data resides in the response buffer allocated and controlled by CLIv2 and altering it may impact CLIv2 in unpredictable ways. Locate mode is provided as a performance option for applications that need only inspect the data. Performance is improved by not copying the data to the application's storage. But if the data must be modified, Locate mode should not be used.