Status Function

Returns a code that provides information about how a preceding function was executed.

Syntax

Status ( )

Remarks

The value returned by Status varies according to the function it is reporting. Lists of possible values are in the descriptions of the functions concerned. You can use Status after the following functions:

  • Fmt
  • Iconv
  • Oconv
  • OpenSeq
  • ReadSeq
  • WriteSeq
  • WriteSeqf

Examples

Here is an example of the Status function being used to check the correct operation of an Iconv function call:

InDate = Iconv(ExtDate, "D2") ;* convert date to internal form
ConvStatus = Status()
Begin Case
Case ConvStatus = 0 
* ...conversion succeeded
Case ConvStatus = 1 
* ...conversion failed - ExtDate not parsable as a date
Case ConvStatus = 2
* ...conversion failed - conversion "D2" invalid (unlikely!)
Case ConvStatus = 3
* ...conversion succeeded, but ExtDate might have been 
* invalid, for example, if it contained the string "31/02/97"
End Case

Here is an example of the Status function being used to check the correct operation of a Fmt function call:

FormattedNum = Fmt(IntNum, "R2$")   ;* format a number
FmtStatus = Status()
Begin Case
Case FmtStatus = 0 
* ...formatting succeeded
Case FmtStatus = 1 
* ... formatting failed - IntNum not convertable to a number
Case FmtStatus = 2
* ... formatting failed - format "R2$" invalid (unlikely!)
End Case