JCI_GetErrorInformation

This function returns more precise error information.

Call

CALL 'JCI_GetErrorInformation' USING eInf

eInf	Error information

Arguments

eInf

A structure of the type Cobvar Structure to which the at most 256-character-long error information of the JCI is to be transferred. The transfer occupies at most the length of the length field. If this is less than or equal to 0 or no error information exists, it is set to 0, and no transfer takes place. If no error information is available, the length field in eInf is set to 0, and the text area remains unchanged.

Return value (RETURN-CODE)

JCI-RET-OK

The call was successful.

Notes

This function can always be called, even when the call of JCI functions is described as invalid, as in, for instance, section "Exceptions".

In the event of an error, more precise information on this error is stored in a joint field by all JCI functions which can supply an error return code. If no error occurs, the field is deleted. As a result, only the information of the function called most recently is ever available. The text is in English and only intended to be displayed to the user.

After the JCI_GetErrorInformation function has been called, the error information is no longer available for further calls.

Example

DATA DIVISION.
WORKING-STORAGE SECTION.
01 eInf.
02 len PIC S9(9) USAGE COMP-5 SYNC VALUE 256.
02 txt PIC X(256).
...
PROCEDURE DIVISION.
...
CALL 'JCI_GetErrorInformation ' USING eInf
IF len IN eInf > 0
DISPLAY txt IN eInf(1:len IN eInf) UPON T
END-IF
...