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

Purpose

The io-exception OMX component, when used with the Encoded File I/O library, allows you to perform advanced exception handling from within an OmniMark program.

The OmniMark I/O Exception dynamic link library file ("omioe.dll" or "omioe.so") creates the io-exception OMX component. The related include file ("omioe.xin") defines the interface to that component. To use io-exception in your program, you must include the following declaration and include statement in your program:

     include "omioe.xin"

Within your program, you can create as many instances of the io-exception component as you require by declaring global and local variables of type "io-exception". For example:

     ; required declaration and include statements
     include "omioe.xin"
  
     ; global io-exception declarations
     global io-exception my-exception-1
     global io-exception my-exception-2
  
     process
        ; local io-exception declarations
        local io-exception my-exception-3
        local io-exception my-exception-4

Once you have declared your io-exception variables, you manipulate them using the functions in the OmniMark I/O Exception function library.

The io-exception component is not copyable. This means that when you set the value of one io-exception OMX variable to the value of another io-exception OMX variable, you end up with two variables pointing at the same external object. You are able to manipulate both variables, but you're performing those manipulations on the same external object, whether you use the original io-exception OMX variable or its copy.

Other Library Functions    get-exception-status    io-exception    io-exception-text    new-io-exception    set-voluntary-end-exception

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]