get-exception-status

function

Library: I/O exception support (OMIOE legacy)
Include: omioe.xin

Returns: Returns a numeric value indicating the current status of the "io-exception" OMX component.

Declaration

define external integer function get-exception-status
         value io-exception ex

Purpose

This function allows you to retrieve the current status of the "io-exception" OMX component.

Argument:

"ex". This is the "io-exception" OMX component whose status you want to retrieve.

Example:

  ; Declaring and using an "io-exception" object to capture the error status,
  ; if any, of reading from a UTF-16 encoded file.
  
  include "omioe.xin"
  process
     local io-exception e
     submit utf16-input-file "widetext.txt" exceptions-to e
     put #error "I/O exception on widetext.txt%n"
         when get-exception-status e != 0
     done

Other Library Functions