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

Return type: String source Returns: An external source object.

Declaration

define external string source function FTPConnectionRemoteInputFile
                        value FTPConnection this-FTPConnection
                 file   value string remote-filename

Argument definitions

this-FTPConnection

is an OMX component of type FTPConnection.

remote-filename

is the name of the file you want to read on the server.

This is an external string source function for reading a remote file on an FTP server. The FTP connection is locked during the lifetime of this source. Any library call that uses the connection will signal an exception while the source is active. Error inquiry functions and the close functions are exceptions and are allowed while the source is active.

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

  include "omftp.xin"

Examples:

  ; read a remote file and put it to #current-output
  output FTPConnectionRemoteInputFile MyCon file "test.dat"

  ; submit a remote file to a set of rules that count letters
  set lc to 0  ; this is a global integer declared earlier
  using group lcount submit FTPConnectionRemoteInputFile MyCon file "test.dat"
  output "Letter-count = %d(lc)%n"
  ...

Other Library Functions    FTPConnection    FTPConnectionChangeDir    FTPConnectionClose    FTPConnectionDelete    FTPConnectionDeleteDir    FTPConnectionGetStatusReport    FTPConnectionGetWorkingDir    FTPConnectionIsInError    FTPConnectionIsOpen    FTPConnectionListDir    FTPConnectionMakeDir    FTPConnectionOpen    FTPConnectionRemoteInputFile    FTPConnectionRemoteOutputFile    FTPConnectionSetASCII    FTPConnectionSetBinary    FTPIsVersionCompatible    FTPLibraryVersion

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