OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P
(a) In a multi-thread environment
PROCEDURE DIVISION
CALL 'CBLDCCLS' USING identifier-1 identifier-2 identifier-3
DATA DIVISION
01 identifier-1.
02 data-name-A PIC X(8) VALUE 'EXCANCEL'.
02 data-name-B PIC X(5).
02 FILLER PIC X(3).
02 data-name-C PIC S9(9) COMP VALUE ZERO.
02 data-name-D PIC 9(4) COMP.
02 FILLER PIC X(2).
02 data-name-E PIC X(n).
01 identifier-2.
02 data-name-F PIC S9(9) COMP.
02 data-name-G PIC X(n).
01 identifier-3.
02 FILLER PIC 9(9) COMP.
02 FILLER PIC 9(4) COMP.
02 FILLER PIC X(2).
02 data-name-H PIC X(n).
(b) In a single-thread environment
PROCEDURE DIVISION
CALL 'CBLDCCLT' USING identifier-1 identifier-2
DATA DIVISION
01 identifier-1.
02 data-name-A PIC X(8) VALUE 'EXCANCEL'.
02 data-name-B PIC X(5).
02 FILLER PIC X(3).
02 data-name-C PIC S9(9) COMP VALUE ZERO.
02 data-name-D PIC 9(4) COMP.
02 FILLER PIC X(2).
02 data-name-E PIC X(n).
01 identifier-2.
02 data-name-F PIC S9(9) COMP.
02 data-name-G PIC X(n).
(2) Purpose
Releases a wait state (enabled by CBLDCCLS('EXNACPT ')) for receiving one-way messages.
When releasing the wait state, the program can issue a message specified for data-name-I to the CUP that awaits one-way messages.
Use this function when using the host name extension function.
(3) Data area where the UAP sets values
- data-name-A
Set VALUE 'EXCANCEL' as the request code for indicating cancellation of a wait for a one-way message.
- data-name-C
Set 0.
- data-name-D
Specify the port number specified for a request to receive one-way messages between 5001 and 65535.
- data-name-E
Specify the name of the host computer corresponding to the CUP that waits for a one-way message. You can specify a maximum of 63# characters for the host name. Terminate the character string with a blank.
You can specify an IP address in decimal dot notation for the host name.
- # If you specify 00000008 for DCCLTOPTION in the client environment definition, you can specify a maximum of 255 characters for the host name.
- data-name-F
Specify the message length. Available values are in the range from 0 to DCRPC_MAX_MESSAGE_SIZE#.
If you specify 0, no messages are sent to the CUP
- # If you specify 2 or a larger value for DCCLTRPCMAXMSGSIZE in the client environment definition, the value you specify is used rather than the value of DCRPC_MAX_MESSAGE_SIZE (1 megabyte).
- data-name-G
Specify the area for storing a notification message to be sent to the CUP. This area must be larger than the length specified for data-name-F.
- data-name-H
Specify the path name of the client environment definition file. The path name must be specified with the full path or with a relative path from the current drive and the current directory. The following shows the order in which files are loaded when the path name is specified.
- In TP1/Client/P
Client environment definition files are loaded in the following order:
1. The BETRAN.INI file in the Windows directory
2. The client environment definition file specified in data-name-H
The definitions in both the client environment definition file and the BETRAN.INI file take effect.
If the same definition is specified in each file with a different value, the value specified in the client environment definition file takes effect.
If neither the client environment definition file nor the BETRAN.INI file contains the necessary specification, TP1/Client/P uses the defaults.
- In TP1/Client/W
All definitions specified in the environment variables will be invalid. TP1/Client/W uses the defaults for definitions that are not specified in the client environment definition file specified in data-name-H.
You can omit the path name by specifying a blank at the beginning of data-name-H. The following describes the operation when the path name is omitted.
- In TP1/Client/P
TP1/Client/P uses the BETRAN.INI file in the Windows directory as the client environment definition file. If the BETRAN.INI file does not exist or if the contents of the definition file are invalid, TP1/Client/P uses the defaults.
- In TP1/Client/W
TP1/Client/W uses the values specified in the environment variables. If an environment variable is not specified, TP1/Client/W uses the default.
The following describes operation when the client environment definition file specified in data-name-H does not exist or when the contents of the definition file are invalid.
- In TP1/Client/P
TP1/Client/P uses the BETRAN.INI file in the Windows directory as the client environment definition file. If the BETRAN.INI file does not exist or if the contents of the definition file are invalid, TP1/Client/P uses the defaults.
- In TP1/Client/W
TP1/Client/W uses the defaults. The values specified in the environment variables will be invalid.
(4) Data area for which a value is returned
- data-name-B
5-digit status code.
(5) Status codes
Status code |
Meaning |
00000 |
Normal termination |
02501 |
Invalid value for the data name. The request code (data-name-A) may be invalid. |
02503 |
Initialization failed. Alternatively, the client environment definition is specified incorrectly. |
02504 |
A necessary amount of buffer could not be allocated. |
02506 |
Network error |
02514 |
The CUP is not in the one-way message reception wait status. |
02518 |
System error |
02539 |
Invalid host computer name |
02547 |
Port numbers that can be assigned automatically by the operating system are insufficient. |
All Rights Reserved. Copyright (C) 2006, 2009, Hitachi, Ltd.