OpenTP1 Version 7 Programming Reference COBOL Language

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

CBLDCMCF('TDCTLE ') - Shut down a logical terminal

Format

PROCEDURE DIVISION specification

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

DATA DIVISION specification

01 unique-name-1.
02 data-name-A PIC X(8) VALUE 'TDCTLE '.
02 data-name-B PIC X(5).
02 FILLER PIC X(3).
02 data-name-C PIC X(4) VALUE SPACE.
02 data-name-D1 PIC X(1) VALUE SPACE.
02 data-name-D2 PIC X(1).
02 data-name-D3 PIC X(26) VALUE SPACE.
02 data-name-E PIC 9(9) COMP.
02 data-name-F1 PIC X(8).
02 data-name-F2 PIC X(56) VALUE SPACE.
02 data-name-G PIC X(8) VALUE SPACE.
02 data-name-H PIC X(8) VALUE SPACE.
02 data-name-I PIC X(144) VALUE SPACE.
02 data-name-J PIC X(184) VALUE SPACE.
02 data-name-K1 PIC 9(9) COMP.
02 data-name-K2 PIC X(n).
01 unique-name-2.
02 data-name-L PIC 9(9) COMP VALUE ZERO.

Description

CBLDCMCF('TDCTLE ') shuts down a logical terminal.

Normal termination of CBLDCMCF('TDCTLE ') indicates that the logical terminal shutdown request was accepted successfully by the protocol product. However, this does not necessarily mean that the logical terminal has been shut down.

If you intend to perform any operation related to the logical terminal after calling CBLDCMCF('TDCTLE '), first use CBLDCMCF('TLSLE ') to check the logical terminal's status.

Data areas whose values are set in the UAP

data-name-A

Specify VALUE 'TDCTLE[Figure]' for the request code indicating logical terminal shutdown.

data-name-C, data-name-D1

Specify a space.

data-name-D2

Specifies whether functionality that depends on the communication protocol is being used.

'1'
Specifies that functionality that depends on the communication protocol is being used.

'0'
Specifies that functionality that depends on the communication protocol is not being used.

Space
'0' (functionality that depends on the communication protocol is not being used) is assumed.

data-name-D3

Specify a space.

data-name-E

Specify the MCF communication process identifier of the MCF communication service that has the logical terminal to be processed. The permitted value range is from 0 to 239.

If you specify 0, the system searches for the MCF communication service to which the specified connection ID belongs. In a configuration where many MCF communication services are running or when you issue this function many times from a UAP, we recommend that you specify the MCF communication process identifier.

data-name-F1

Specify the name of the logical terminal that is to be shut down. Express the logical terminal name as a maximum of 8 bytes. If the specified name is shorter than 8 bytes, pad the name with trailing spaces.

data-name-F2, data-name-G, data-name-H, data-name-I, data-name-J

Specify a space.

data-name-K1

Specify the length of a protocol-specific area. You can specify a maximum of 1024 bytes.

If you do not use functionality that depends on the communication protocol, specify 0.

data-name-K2

Specify contents for the protocol-specific area.

The permitted value depends on the communication protocol being used. For details, see the applicable OpenTP1 Protocol manual.

data-name-L

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 Normal termination.
71001 CBLDCMCF('TDCTLE ') cannot be accepted because MCF is under start processing.
71002 CBLDCMCF('TDCTLE ') cannot be accepted because MCF is under termination processing.
71004 A memory shortage occurred during CBLDCMCF('TDCTLE ') processing.
71005 A communication error occurred. For the cause, see the message log file.
71006 An internal error occurred. For the cause, see the message log file.
71008 The specified logical terminal name has not been registered.
71009 CBLDCMCF('TDCTLE ') is not supported by the applicable communication process.
71010 Although the request to shut down the logical terminal was issued to the MCF communication process, the request was not accepted. For the cause, see the message log file.
71011 CBLDCMCF('TDCTLE ') cannot be accepted because the logical terminal has been deleted.
72028 The value specified for data-name-A is invalid.
72052 <If '0' or a space is specified for data-name-D2>
A nonzero value is specified for data-name-K1.
<If '1' is specified for data-name-D2>
A value smaller than 0 or greater than 1024 is specified for data-name-K1.
72053 A nonzero value is specified for data-name-L.
72058 The value specified for data-name-C is not a space.
72059 The value specified for data-name-D2 is not 1, 0, or a space.
The value specified for data-name-D3 is not a space.
72061 A value smaller than 0 or greater than 239 is specified for data-name-E.
72063 data-name-F1 begins with a space.
72065 The value specified for data-name-F2 is not a space.
72066 The value specified for data-name-G is not a space.
72068 The value specified for data-name-H is not a space.
72070 The value specified for data-name-I is not a space.
72072 The value specified for data-name-J is not a space.
72074 The character string specified for data-name-F1 contains an invalid character.
72075 The value specified in data-name-D1 is not a space.