OpenTP1 Version 7 Programming Reference COBOL Language

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

CBLDCDAM('HOLD') - Shut down a logical file

Format

PROCEDURE DIVISION specification

CALL  'CBLDCDAM'  USING  unique-name-1  unique-name-2

DATA DIVISION specification

01  unique-name-1.
    02  data-name-A    PIC X(8) VALUE 'DCDAMSVC'.
    02  data-name-B    PIC X(5).
    02  FILLER       PIC X(3).
    02  data-name-C    PIC X(8).
    02  FILLER       PIC S9(9) COMP.
    02  FILLER       PIC S9(9) COMP.
    02  FILLER       PIC X(32).
01  unique-name-2.
    02  data-name-E    PIC X(4) VALUE 'HOLD'.
    02  FILLER       PIC X(1).
    02  FILLER       PIC X(1).
    02  FILLER       PIC X(1).
    02  FILLER       PIC X(1).
    02  data-name-Z    PIC S9(9) COMP VALUE ZERO.

Description

CBLDCDAM ('HOLD') shuts down a logical file. After a logical file is logically shut down, a logical shutdown error is always returned if another UAP issues an access request for the logical file specified here.

Data areas whose values are set in the UAP

data-name-A

Specify VALUE 'DCDAMSVC' for the interface code used with the DAM file.

data-name-C

Specify a logical file name with up to 8 characters. If the specified logical file name comprises less than 8 characters, pad the remaining portion with space.

data-name-E

Specify VALUE 'HOLD' for the request code indicating that the logical file is in shutdown state.

data-name-Z

Specify 0.

Data area to which a value is returned from OpenTP1

data-name-B

A status code of 5 digits is returned.

Status codes

Status code Explanation
00000 The specified logical file was shut down normally.
01600 CBLDCRPC('OPEN ') was not called.
'N' is specified for atomic_update in the user service definition. (This error is returned only when accessing a recoverable DAM file.)
CBLDCDAM('STRT') was not called. (This error is returned only when accessing an unrecoverable DAM file.)
The UAP is incorrectly linked as follows:
  • The library (-1tdam) to be used for access to a TAM file using the DAM service API is linked incorrectly.
  • The definition of the resource manager for transaction control object files is incorrect.
01601 The specified logical file name has not been defined.
01607 The memory became insufficient.
01610 The value specified as the logical file name is invalid.
01618 The version of the DAM library linked to the UAP does not allow the UAP to operate with the current DAM service.
01625 The logical file name specified for data-name-C is in logical shutdown state.
01626 The logical file name specified for data-name-C is in shutdown state due to an error.
01628 The DAM file to be accessed is protected by the security facility. The UAP attempting to shut down the logical file has no access permission.
01646 The DAM file to be shut down is protected by the security facility. No ACL exists for the file.
01690 The interface code (data-name-A) is invalid.
01691 The request code (data-name-E) is invalid.