FTPConnectionGetStatusReport

function

Library: FTP support (OMFTP)
Include: omftp.xin

Declaration

define external function FTPConnectionGetStatusReport
           value FTPConnection this-FTPConnection
      into write-only string report

Argument definitions

this-FTPConnection: is an OMX component of type FTPConnection

report: is a stream shelf in which the error messages are stored

Purpose

This function clears the report shelf if the FTP connection is not in error, and populates the report shelf with one or more error messages (each of which is an item on the shelf) if the FTP connection is in error.

The error messages stored in report are typically generated by the FTP server. Other possible messages generated by the library itself are:

  No Connection initiated
  Error in the control connection
  Error in the data connection
  Invalid input
  Socket error
  File unavailable
  Connection Timed out

To use this function, you must include the following line near the start of your program:

  include "omftp.xin"

Example:

  ; example of an error-reporting function
  define function ftp-err value FTPConnection con
  as
    local string report variable
    do when FTPConnectionIsInError con
       put #error "FTP error:%n"
       FTPConnectionGetStatusReport con into report
       repeat over report
          put #error report || "%n"
       again
       halt
    done

Other Library Functions