OpenTP1 Version 7 Programming Reference COBOL Language

[Contents][Index][Back][Next]

CBLDCTAM('INFO') - Acquire TAM table information

Format

PROCEDURE DIVISION specification

CALL  'CBLDCTAM'  USING  unique-name-1  unique-name-2
                         unique-name-3

DATA DIVISION specification

01  unique-name-1.
    02  data-name-A    PIC X(4).
    02  data-name-B    PIC X(5).
    02  FILLER        PIC X(103).
    02  data-name-C    PIC S9(4) COMP.
    02  FILLER        PIC X(398).
01  unique-name-2.
    02  data-name-D    PIC X(4).
    02  FILLER        PIC X(4).
01  unique-name-3.
    02  unique-name-4.
        03  data-name-E    PIC X(32).
        03  data-name-F    PIC X(2).
        03  data-name-G    PIC X(64).
        03  FILLER        PIC X(2).
        03  data-name-H    PIC S9(9) COMP.
        03  data-name-I     PIC S9(9) COMP.
        03  data-name-J     PIC X(1).
        03  data-name-K     PIC X(1).
        03  data-name-L     PIC X(1).
        03  FILLER        PIC X(1).
        03  data-name-M    PIC S9(9) COMP.
        03  data-name-N    PIC S9(9) COMP.
        03  data-name-O    PIC S9(9) COMP.
        03  data-name-P    PIC X(1).
        03  FILLER        PIC X(3).
                :
                :
                :
    02  unique-name-n.
        03  data-name-E    PIC X(32).
        03  data-name-F    PIC X(2).
                :
        03  data-name-P    PIC X(1).
        03  FILLER        PIC X(3).

Description

CBLDCTAM('INFO') returns TAM table information. The following values are returned by CBLDCTAM('INFO'):

TAM table information can be acquired from inside or outside of a transaction.

Data areas whose values are set in the UAP

data-name-A

Specify the TAM identifier. The TAM service does not reference this value.

data-name-C

Specify the length of area that receives TAM table information (the length of unique-name-3).

data-name-D

Specify VALUE 'INFO' for the request code indicating that TAM table information is acquired.

data-name-E

Specify the name of the TAM table from which information is acquired with up to 32 characters. End the character string with space.

Data areas whose values are returned from OpenTP1

data-name-B

A status code of 5 digits is returned.

data-name-F

The TAM table status is returned as follows:

VALUE 'RO': The TAM table is opened.

VALUE 'RC': The TAM table is closed.

VALUE 'HL': The TAM table is in logical shutdown state.

VALUE 'HB': The TAM table is in shutdown state due to an error.

data-name-G

The TAM file name of the TAM table is returned.

data-name-H

The number of records currently used in the TAM table is returned. However, this value is not assured if a record is added or deleted after CBLDCTAM('INFO') is called.

data-name-I

The maximum number of records for the TAM table is returned.

data-name-J

The index type of the TAM table is returned as follows:

VALUE 'H': The TAM table adopts hash format.

VALUE 'T': The TAM table adopts tree format.

data-name-K

The access type of the TAM table is returned as follows:

VALUE 'R': The TAM table is reference-only type.

VALUE 'W': The TAM table is overwrite type (any record cannot be added or deleted).

VALUE 'A': The TAM table is update type (records can be added or deleted).

VALUE 'L': The TAM table is update type (records can be added and deleted without locking the table).

data-name-L

The loading opportunity of the TAM table is returned as follows:

VALUE 'S': The TAM table is loaded when the TAM service is started.

VALUE 'L': The TAM table is loaded when the TAM table is opened by the function dc_tam_open().

VALUE 'C': The TAM table is loaded when the tamload command is executed.

data-name-M

The record length of the TAM table is returned.

data-name-N

The key length of the TAM table is returned.

data-name-O

The key start position in the TAM table data is returned.

data-name-P

The security attribute of the TAM table specified in the TAM service definition is returned as follows:

VALUE 'N': Security is not specified.

VALUE 'S': Security is specified.

Status codes

Status Code Explanation
00000 Information was acquired from the TAM table normally.
01701 The value specified for data-name-E is invalid.
01705 The value specified for data-name-C is invalid.
01708 The value specified for data-name-D (request code) is invalid.
01709 The name specified for data-name-E is not a TAM table.
01710 The TAM table has not been defined.
01720 The TAM service is being terminated.
01721 The sequence of accessing the TAM table is invalid.
The resource manager registration of the object file for control of transactions having a linkage with the UAP is invalid. Alternatively, there is no linkage between the object file for control of transactions and the UAP.
atomic_update=N (nontransaction attribute) is specified in the user service definition of the UAP which called CBLDCTAM.
01760 The version of the TAM library linked to the UAP does not allow the UAP to operate with the current TAM table.
01762 The version of the TAM library linked to the UAP does not allow the UAP to operate with the current TAM service.
01766 The number of open character special files exceeds the specified limit.
01767 The access permission for special files has not been granted.
01769 The memory became insufficient.
01770 An input/output error occurred.
01772 The TAM table from which information is acquired is protected with the security facility. There is no ACL for the corresponding TAM table.
01773 The TAM table from which information is acquired is protected with the security facility. The UAP that called CBLDCTAM('INFO') has no access permission.