STATUS

READ, WRITE, OPEN

Previous Operation

Value = 0 if successful

Value = Operating System error code if previous command failed

13 - permission denied on UNIX systems

OCONV Conversions

0 = successful

1 = invalid conversion requested

3 = conversion of possible invalid date

COMMAND SYNTAX

    STATUS()

DESCRIPTION

Arguments are required for the STATUS function.

Values of STATUS after CLOSE, DELETE, MATREAD, MATWRITE, OPEN, READ and WRITE

After a DELETE statement: After a DELETE statement with an ON ERROR clause, the value returned is the error number.

Returns 0 if successful else returns ERROR number

After an OPEN, OPENPATH, or OPENSEQ statement: The file type is returned if the file is opened successfully. If the file is not opened successfully, the following values may return:

After a READ statement: If the file is a distributed file, the STATUS function returns the following:

After a READL, READU, READVL, or READVU statement: If the statement includes the LOCKED clause, the returned value is the terminal number, as returned by the WHO command, of the user who set the lock.

After a READSEQ statement:

After a READT, REWIND, WEOF, or WRITET statement: The returned value is hardware-dependent (that is, it varies according to the characteristics of the specific tape drive unit). Consult the documentation that accompanied your tape drive unit for information about interpreting the values returned by the STATUS function.

EXAMPLE

       DELETE not_valid_filevar, 'REC5' SETTING ret_code ON ERROR
          CRT 'REC5 - DELETE ERROR'
       END
       CRT STATUS()           ;*  -1
       CRT ret_code           ;*  32768

TAFJ note: STATUS() function works incorrectly processing results of erroneous conversions. Example:

       CRT OCONV('qwerty', 'qwerty') : '_' : STATUS()   ;* expected: _1, output: _2
       CRT ICONV('20483344', 'D') : '_' : STATUS()      ;* expected: _3, output: _1