OpenTP1 Version 7 Programming Reference COBOL Language

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

CBLDCTAM('GST ') - Acquire TAM table status

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(35).
    02  data-name-C    PIC X(4).
    02  FILLER        PIC X(64).
    02  data-name-D    PIC S9(4) COMP.
    02  FILLER        PIC X(398).
01  unique-name-2.
    02  data-name-E    PIC X(4).
    02  FILLER        PIC X(4).
01  unique-name-3.
    02  unique-name-4.
        03  data-name-F    PIC X(32).
        03  data-name-G    PIC X(2).
        03  FILLER        PIC X(6).
            :
            :
    02  unique-name-n.
        03  data-name-F    PIC X(32).
        03  data-name-G    PIC X(2).
        03  FILLER        PIC X(6).

Description

CBLDCTAM('GST ') acquires the status of a TAM table. The TAM table status to be acquired includes the following:

The program that acquires TAM table information can be called both outside and inside the transaction.

Even if the TAM table is accessed by another processing, the program that acquires TAM table information returns assuming that the TAM table is open.

Data areas whose values are set in the UAP

data-name-A

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

data-name-D

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

data-name-E

Specify VALUE 'GST ' for the request code indicating acquisition of TAM table information.

data-name-F

Specify the name of the TAM table whose status is to be acquired. The name can be specified with up to 32 characters. If the specified name comprises less than 32 characters, pad the remaining portion with space.

Data areas whose values are returned from OpenTP1

data-name-B

A status code of 5 digits is returned.

data-name-C

The status of the specified TAM table is returned to the 4-byte area. Table 2-2 explains the status indicated by each byte.

Table 2-3 TAM table status

Byte Status Explanation
0 L There is a TAM table in logical shutdown state.
Space There is not a TAM table in logical shutdown state.
1 B There is a TAM table in shutdown state due to an error.
Space There is not a TAM table in shutdown state due to an error.
2 O There is a TAM table in open state.
Space There is not a TAM table in open state.
3 C There is a TAM table in closed state.
Space There is not a TAM table in closed state.

data-name-G

The status of the specified TAM table is returned.

VALUE 'RO': Open state

VALUE 'RC': Closed state

VALUE 'HL': Logical shutdown state

VALUE 'HB': Shutdown state due to an error

Status codes

Status code Explanation
00000 TAM table information was acquired normally.
01701 The TAM table name specified for data-name-F is invalid.
01705 The value specified for data-name-G is invalid.
01708 The value specified for data-name-E is invalid.
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.
01762 The version of the TAM library linked to the UAP does not allow the UAP to operate with the current TAM service.
01772 The accessing TAM file is protected by the security facility. No ACL exists for the file.
01773 The accessing TAM file is protected by the security facility. The UAP attempting to get the status of the TAM table has no access permission.