TBLBASE Parameter Descriptions

Table 112. tableBASE parameters

TBLBASE Parameter

Size

Description

ALT DEFINITION

(12 bytes)

Used to create an Alternate Index Definition of a table.

  • 1. ORG

(1 byte)

Organization: may be R, U, S, D or H. Default = R.

  • 2. METHOD

(1 byte)

Search method: S, Q, B, C or H. Default depends on ORG.

  • 3. KEY-COUNT

(halfword binary)

Must be set to 1. Default = 1.

  • 4. KEY-LOCATION

(fullword binary)

Default = 1.

  • 5. KEY-SIZE

(fullword binary)

Default = 1.

COMMAND-AREA

(72 bytes)

Required by all commands.

  • 1. COMMAND

(2 bytes)

Set by program.

  • 2. TABLE

(8 bytes)

Set by program.

  • 3. FOUND

(1 byte)

Set by tableBASE. Only valid if ERROR=0. Check after calling tableBASE for retrieval (SK, FK, FC, FG, FN, GF, GL, GN, and GP); for update (DK, RK, IK, DC, and RC); and commands GD and NX.

  • 4. INDIRECT-OPEN

(1 byte)

Set by program to I for Indirect access or initialized to HEX zeroes.

  • 5. RESERVED

(1 byte)

Set by program. Initialized to HEX zeroes.

  • 6. ABEND-OVERRIDE

(1 byte)

Set by programmer for temporarily overriding abend status.

  • 7. ERROR

(halfword binary)

Set by tableBASE.

  • 8. COUNT

(fullword binary)

Set by program for FC, DC, RC, & IC commands. Set by tableBASE after Key Retrieval, Update, and Get commands (G*).

  • 9. LOCK-LATCH

(8 bytes)

Required to control update processing in a multi-user / shared environment.

  • 10. ROW-OVERRIDE-LENGTH

(fullword binary)

This field denotes the relevant portion of the application’s row area to be used for retrieval and update requests. If this field is zero then the actual row length is used, as specified in the table definition.

  • 11. ROW-ACTUAL-LENGTH

(fullword binary)

tableBASE returns the actual length of a fetched row, as specified in the table definition block, in this field.

  • 12. FG-KEY-LENGTH

(halfword binary)

A non-zero value in this field denotes the relevant length of a generic key parameter in a Fetch Generic request.

  • 13. FUNCTION-ID

(halfword binary)

Used to distinguish between normal tableBASE processing and other specialized types of processing.

  • 14. DATE

(8 bytes)

This field is used for date-sensitive processing.

  • 15. RESERVED

(19 bytes)

  • 16. START-TBUOW

(1 byte)

Set by program to S before a tableBASE command to access the current generation of a VTS-TSR. Reinitialized by tableBASE to low-values after every tableBASE command.

  • 17. RETURNED-ABS-GEN-NO

(halfword binary)

Returns absolute generation number of the open table. Returns a zero for all non table commands.

  • 18. ERROR-SUB-CODE

(halfword binary)

Set by tableBASE.

DATA-TABLE-NAME

(8 bytes)

Table for which an alternate index is created.

DDNAME

(8 bytes)

The DDNAME of a tableBASE Library.

DEFINITION-BLOCK

(256 bytes)

Used with DT, CD, GD and DD commands. 1-14 and 31 used by DT and CD commands; 1-33 returned by the GD command; 1-17 returned by DD command.

  • 1. ORG

(1 byte)

May be R, U, S, D, or H, Default =R.

  • 2. METHOD

(1 byte)

Search Method; S, Q, B, C or H. Default depends on ORG.

  • 3. INDEX

(1 byte)

T = True table, P = Pointer table. Default = P.

  • 4. SMC

(1 byte)

Storage Mode Code. R = Resident. Default = R.

  • 5. RPSWD

(8 bytes)

READ-PASSWORD. Default=null password.

  • 6. WPSWD

(8 bytes)

WRITE-PASSWORD. Default = Read Password.

  • 7. RSZ

(fullword binary)

ROW-SIZE. Default = 1.

  • 8. KSZ

(fullword binary)

KEY-SIZE. Default = ROW SIZE or 256, whichever is less.

  • 9. KLOC

(fullword binary)

KEY-LOCATION. Default = 1.

  • 10. ROWS

(fullword binary)

NUMBER-OF-ROWS. Default will vary according to row size and table organization.

  • 11. GENERATIONS

(halfword binary)

The maximum number of generations to be kept. Default = 1.

  • 12. EXP-FACT

(halfword binary)

EXPANSION FACTOR

Default = 200 (20%). (1 to 999 expressed in thousandths.)

  • 13. LO-DEN

(halfword binary)

LOW DENSITY – used for Hash tables

Default = 500 (50%). (1 to 999 expressed in thousandths.)

  • 14. HI-DEN

(halfword binary)

HIGH DENSITY – used for Hash tables

Default = 800 (80%). (1 to 999 expressed in thousandths.)

  • 15. RESERVED

(6 bytes)

  • 16. DATE

(12 bytes)

YYYYMMDDHHMM – date created or last stored

  • 17. ABS-GEN-NO

(halfword binary)

Absolute Generation number, returned by GD Command.

  • 18. DATASET-NAME

(44 bytes)

Dataset name of the library the table resides on.

  • 19. REL-GEN-NO

(halfword binary)

Relative Generation number.

  • 20. GENS-PRESENT

(halfword binary)

Number of Generations.

  • 21. ROWS-AT-EXPAND

(fullword binary)

Maximum number of rows that an open table can hold before it must be expanded.

  • 22. DDNAME

(8 bytes)

Of the tableBASE library.

  • 23. DATA-TABLE

(8 bytes)

Table name when GD command is for an open Alternate Index.

  • 24. OPEN-STATUS

(1 byte)

Indicates if table is not open X, open for Read R, open for Write, W.

  • 25. ALTS-INVOKED

(1 byte)

ALTERNATES-INVOKED

Indicates if there are Alternate Indexes for table (Y or N).

  • 26. VIEW-VERSION

(1 byte)

Format of the View table (FDT).

  • 27. RESERVED

(1 byte)

  • 28. USERID

(8 bytes)

Userid of last user to update the table.

  • 29. VIEW-NAME

(8 bytes)

Name of the View table normally used to display the table in an online environment.

  • 30. VIEW-DATE

(12 bytes)

Creation date of View used to display table in tablesONLINE/CICS environment.

  • 31. USER-COMMENTS

(16 bytes)

Comments entered by the user.

  • 32. VTSNAME

(8 bytes)

The name of the VTS-TSR in which the table resides (if applicable).

  • 33. RESERVED

(68 bytes)

DIR-SPEC

(9 bytes)

Specifies tables included in a Directory List.

  • 1. TABLE-NAME-MASK

(8 bytes)

Identifies a table name or partial table name.

  • 2. DIRTYPE

(1 byte)

Specifies a category of tables (View tables, Data tables, all Tables, or List first generation).

GENERATION

(fullword binary)

The number of the generation to be used.

INDIRECT-OPEN-CRITERION

(50 bytes)

The value to activate a secondary (indirect) table. See tableBASE Programming Guide.

KEY-AREA

(Key length)

An area to contain the key.

LIB-LIST

(80 bytes)

The DDNAMES (8 bytes each) of up to 10 tableBASE Libraries (LIB-1 through LIB-10). Can include VTSs by including VTS prefix: VTS:xxxx.

LIB-SPACE

(2 fullwords binary)

Counters: BLOCKS-ALLOCATED and BLOCKS-REMAINING.

LIBRARY-ALLOC

(45 bytes)

S for share, O for old, followed by DATASET name (44 bytes).

LIST-BLOCK

(88 bytes)

Provides dynamic tableSPACE report. See Programming Guide for more details.

NAME-AREA

(256 bytes)

A work area for the client name and banner information.

NEW-GEN-NO

(fullword binary)

The new number of generations to be kept.

NEW-TABLE-NAME

(8 bytes)

The name to which this table is being changed.

PASSWORD

(8 bytes)

The read or write password for this table.

RELEASE-LEVEL

(16 bytes)

tableBASE release information.

ROW-AREA

(Row length)

Area to contain one row of the table.

STATUS-SWITCHES

(8 bytes)

Used for listing (LS) or altering (CS) the operational characteristics of tableBASE; may be Y, N or blank (handling is to remain as previously set).

  • 1. ABEND

(1 byte)

Abend processing occurs for errors 0001-0099, 1000-1099.

  • 2. WAIT

(1 byte)

tableBASE should wait for tables which are enqueued.

  • 3. HASH-EMPTIES-RETURNED

(1 byte)

tableBASE should return empty rows from hash tables.

  • 4. DEFAULT-OPEN

(1 byte)

tableBASE should automatically open tables for read.

  • 5. TRACE

(1 byte)

tableBASE should maintain a Trace of the last ten commands per thread.

  • 6. RESERVED

(3 bytes)

TABLE-AREA

Area to receive the contents of the table being dumped. See the tableBASE Programming Guide.

TABLE-STATS

An array used to receive the table statistics from the LT command.

  • 1. TABLE-NAME

(8 bytes)

The name of the open table.

  • 2. TABLE-OPEN-STATUS

(1 byte)

Open status of the table: W or R.

  • 3. TABLE-LOCAL-VTS

(1 byte)

Indicates if table is in the current TSR (L), or is a “linked-table” in a VTS-TSR (V).

  • 4. TABLE-ALT-INVOKED

(1 byte)

Indicates if there are Alternate Indexes invoked Y or N.

  • 5. RESERVED

(1 byte)

  • 6. TABLE-CALLS

(fullword)

Number of calls made against the table since it was opened (truncated to a fullword).

  • 7. TABLE-SIZE

(fullword)

Size of the table in bytes.

  • 8. TABLE-ROWS

(fullword)

The number of rows currently in the table.

  • 9. TABLE-RWS-BF-EXP

(fullword)

Number of rows that the table can contain before expansion.

  • 10. TABLE-DATATBL-VTSNAME

(8 bytes)

The name in the form VTS:xxxx (Linked table).

  • 11. TABLE-UPDATE-CALLS-TRUNC

(fullword)

Number of updates to this table (truncated to a fullword).

  • 12. TABLE-DATE-TIME

(12 bytes)

Date, time the table was last stored to a library – format = YYYYMMDDHHMM

  • 13. RESERVED

(4 bytes)

  • 14. TABLE-TOTAL-CALLS

(double word binary)

Number of calls made to table since opened.

  • 15. TABLE-UPDATE-CALLS

(double word binary)

Number of updates to the table since opened.

  • 16. TABLE-VTSNAME

(8 bytes)

Name of the VTS-TSR, if a Linked table.

TBACC-DEF

(32 bytes)

A TBACC Table Definition area. See Programming Guide.

TBINDEX-DEF

(32 bytes)

A TBINDX Table Definition area. See Programming Guide.

TB-PARM: V5

(64 bytes)

General communications area (enables high performance).

  • 1. TB-PARM-ID

(2 bytes)

The literal TB identifies this parameter as the TB-PARM communications area.

  • 2. RESERVED

(2 bytes)

  • 3. TB-VERSION

(1 byte)

The major tableBASE release level. It must be set to 5 for Release 5 or higher TBLBASE interface.

  • 4. TB-FORMAT

(1 byte)

The value A identifies the format of the COMMAND-AREA as a 28 byte Release 4.x format or the value 0 identifies the format as a 72 byte Release 5/6 format.

  • 5. RESERVED

(10 bytes)

  • 6. TB-TPVM

(8 bytes)

Specifies which VTS Group Manager (TPVM) to use for VTS access. VTS Manager only.

  • 7. TB-SUBSYSTEM

(8 bytes)

The VTS-TSR sub-system for tableBASE operations. If left blank or HEX zeroes, tableBASE operates on the local TSR.

  • 8. RESERVED

(4 bytes)

  • 9. TB-TURBO-ANCHOR

(8 bytes)

This field is used to anchor threads for multitasking. It must be set to HEX zeroes (LOW-VALUES) or blanks at the beginning of each thread and is subsequently managed by tableBASE. In batch, a thread is an MVS task; in CICS it is a transaction.

  • 10. RESERVED

(20 bytes)

VTS-DATA

(60 bytes)

Provides VTS name information with the LV command.

  • 1. RESERVED

(8 bytes)

  • 2. VTS-VTSFIRST

(8 bytes)

Returns the VTSFIRST parameter from TBOPT.

  • 3. VTS-VTSLAST

(8 bytes)

Returns the VTSLAST parameter from TBOPT.

  • 4. VTS-VTSNAME

(8 bytes)

Returns the VTSNAME parameter from TBOPT or the VTS-NAME parameter from the VS command; the value from a VS command overrides the TBOPT value.

  • 5. RESERVED

(8 bytes)

  • 6. VTS-TSRACCESS

(1 byte)

Returns the TSRACCESS run-time option for the VTS.

  • 7. VTS-RACF-VTS

(1 byte)

Returns the RACF_VTS run-time option for the VTS.

  • 8. VTS-TSR-KEY-PROTECT

(1 byte)

Returns the TSR_KEY_PROTECT run-time option for the VTS.

  • 9. RESERVED

(3 bytes)

  • 10. VTS-GENERATION

(2 bytes)

Returns the generation number of the VTS-TSR.

  • 11. VTS-TPVM

(8 bytes)

Returns the TPVM name from TBOPT. For use when the VTS Manager product is used.

  • 12. VTS-PREFIX

(4 bytes)

Returns the VTSPREFIX from TBOPT. Used in the ML library seach list.

VTS-NAME

(8 bytes)

Used to pass the name of the VTS-TSR to the VS command.