Return code for the file management CALL macros

The following descriptions are only valid for the file management CALL macros (NDEL, NLMOD, NLSHOW, NMOD and NSHOW).

Maincode

This field contains the exact error. It is divided into two bytes. The right byte shows the cause of the error. It can have the following values (in decimal notation):

0:	the call was error-free
1:	the parameter field is partially or entirely in an invalid address space
2:	the address or length field contradict the keyword field
3:	the parameter entry contradicts another parameter
4:	the parameter value is too long or violates syntax rules; e.g. FILENAME, PASSWORD
10:	the buffer is too small; this error code is reserved for future expansions
11:	the arithmetic parameter value (e.g. RECSIZE value) is invalid
12:	the keyword entered is not permitted for this parameter
13:	a mandatory parameter is missing

The left byte is only set to a value other than 0 if there is a parameter error. It specifies the parameter in which the error occurred. The meaning of these values can be found in the description of the Assembler macro YNDEQU on "Set YNDEQU constants for the openFT macros".

If the left byte is set to 0, the right byte contains the message number indicating the result of the macro.

For compatibility reasons, the message numbers valid up to and including openFT V9 are still output at the Cobol interface. You find an conversion table between old and new return codes in section „Maincode conversion table“ in the appendix of the openFT V11.0 User Guide.

Subcode1

The error codes are divided into error classes. These are identified in subcode 1. The following error classes exist:

Class	Value	Meaning
A	0	the call was successfully completed
B	1	permanent error, no repetition possible, there was a syntax error or equivalent parameter error
C	32	system error an internal error occurred during macro processing
D	64	repeat after correction of user input
E	128	wait and repeat

Subcode2

This field contains a warning, if the macro was completed successfully (subcode1 = 0 and maincode = 0) but the macro couldn’t be executed - for instance, if no files could be found during the NSHOW call.

Exception

If the maincode contains the value X’FFFF’, the request could not be executed for reasons specified uniquely throughout the system.