OpenTP1 Version 7 Programming Reference COBOL Language
CBLDCLOG('PRINT ') - Output message log
Format
PROCEDURE DIVISION specification
CALL 'CBLDCLOG' USING unique-name-1 unique-name-2 unique-name-3 |
DATA DIVISION specification
01 unique-name-1. 02 data-name-A PIC X(8) VALUE 'PRINT '. 02 data-name-B PIC X(5). 02 FILLER PIC X(3). 02 data-name-Z PIC S9(9) COMP VALUE ZERO. 02 data-name-C PIC X(12). 02 data-name-D PIC X(3). 02 FILLER PIC X(1). 02 data-name-E PIC S9(9) COMP. 01 unique-name-2. 02 data-name-F PIC S9(9) COMP. 02 data-name-G PIC X(n). 01 unique-name-3. 02 data-name-H PIC S9(9) COMP. |
Description
CBLDCLOG('PRINT ') outputs the character string specified for data-name-G to the message log file. Before the output, it adds the following information to the character string through OpenTP1:
The OpenTP1 assigns ID numbers 05000 to 06999 to the messages used for CBLDCLOG('PRINT '). To messages output from your UAP, assign ID numbers in the range from 05000 to 06999.
Even if an error occurs, the status code 00000 might be returned. Consequently, a message log might be missing. The missing message log can be identified by checking the message log serial numbers in the message log file.
If the message log is output more than once from one process, the sequence of output to the message log file is ensured. However, if the message log is output from each of multiple processes, the message logs might not be output to the message log file in the call sequence.
If a communication error (01901) or a log service inactive error (01905) occurs, the message output from the UAP is edited in the UAP process and is output to the standard error output file. Either of the following codes which indicate the causes of errors is added to the end of the message:
When an error other than E1 or E2 is detected, the OpenTP1 prints a log message which indicates the cause of the error to the standard error output. This message is assigned the message ID number specified by CBLDCLOG('PRINT ').
Data area whose values are set in the UAP
data-name-A
Specify VALUE 'PRINT' for the request code indicating a request of message log output.
data-name-Z
Specify 0.
data-name-C
Specify the message ID to be assigned to each message log. The message ID must be in the KFCAn1n2n3n4n5-x format (11 characters) and end with a null character. Specify a value from 05000 to 06999 for the serial number (n1n2n3n4n5) output from the UAP.
data-name-D
Specify a user-selected value (request source program ID) for identifying the UAP that output the message log. The value must comprise two alphanumeric characters and end with a null character.
data-name-E
Specify the display color of the message log specified in CBLDCLOG('PRINT ') when the message log is output to the NETM operation support terminal. The following colors are available:
VALUE '1': Green
VALUE '2': Red
VALUE '3': White
VALUE '4': Blue
VALUE '5': Purple
VALUE '6': Sky blue
VALUE '7': Yellow
If a value other than the above or space is specified, green is assumed to be specified.
data-name-F
Specify the length of the character string that is to be output as a message log to the message log file. The length can be specified with up to 222 bytes.
data-name-G
Specify the character string that is to be output as a message log to the message log file.
data-name-H
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. |
01900 | The value specified for the data-name is invalid. This error also occurs if the request code (data-name-A) is invalid. |
01901 | A communication error occurred or CBLDCRPC('OPEN ') was not issued. |
01902 | The memory became insufficient. |
01904 | The system definition is invalid. |
01905 | The message log service is not active. |
01906 | An error occurred when the message log service acquired the information to be added to the message log. |
Note
When a large log is output, return of the CBLDCLOG('PRINT ') may be delayed. For example, when the volume of output messages greatly increases upon occurrence of an error, the transaction processing time increases. Note that this may cause a slowdown.
All Rights Reserved. Copyright (C) 2006, 2010, Hitachi, Ltd.