FTPConnectionListDir

function

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

Returns: a directory listing

Declaration

define external stream function FTPConnectionListDir
                        value FTPConnection this-FTPConnection
                    dir value string dir optional
                   full value switch full optional initial {false}

Argument definitions

this-FTPConnection: is an OMX component of type FTPConnection

dir: allows you to specify a different directory for which the contents should be listed.

full: is a switch value that, when true, will cause this function to return a full UNIX-style directory listing (including file permissions, and so forth). When set to false, only the filenames will be returned.

Purpose

This function lists the entries in the current directory or another specified directory.

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

  include "omftp.xin"

Examples:

  ; list directory contents with full listing
  output FTPConnectionListDir MyCon full true

  ; list the contents of the subdirectory "test-dir"
  output FTPConnectionListDir MyCon dir "test-dir" full true

Other Library Functions