MailInBoxGetStatusReport
Full Description
swirl
Syntax
  define external function MailInBoxGetStatusReport
                  value MailInBox this-MailInBox
            into modifiable stream report


Purpose

If the MailInBox is not in error, this function clears the report shelf; if the MailInBox is in error, the function populates the report shelf with one or more error messages (each as an item on the shelf).

MailInBoxGetStatusReport can be called at any time, but will return an empty report shelf if there is no error.

Arguments:

  • "this-MailInBox" is an opaque object of type MailInBox.
  • "report" is the stream shelf in which the error messages are stored.

Example:

  MailInBoxGetStatusReport MyBox into report
  repeat over report
     put #error report
  again

Copyright © OmniMark Technologies Corporation, 1988-1998.