:GetDirectoryFormat()

Class

     aprFTP()

 

Syntax

     :GetDirectoryFormat( [hSession] ) -> nFormat

 

Parameters

 

hSession

Optional: If hSession is not passed, the value in :Session will be used

 

Return

Returns a numeric value indicating the format being used by the server to list files

 

Constant

Description

FTP_DIRECTORY_AUTO

This value specifies that the library should automatically determine the format of the file lists returned by the server.

FTP_DIRECTORY_UNIX

This value specifies that the server returns file lists in the format commonly used by UNIX servers (i.e.: the output from the /bin/ls command)

FTP_DIRECTORY_MSDOS

This value specifies that the server returns file lists in the format commonly used by MS-DOS based systems.

This includes Windows NT servers.

FTP_DIRECTORY_VMS

This value specifies that the server returns file lists in the format commonly used by VMS servers.

FTP_DIRECTORY_STERLING_1
FTP_DIRECTORY_STERLING_2

This value specifies that the server returns file lists in the proprietary formats used by the Sterling server, which is used for EDI (Electronic Data Interchange) applications.

 

Description

The :GetDirectoryFormat() method returns an identifier which specifies what format is being used by the server to list files.

By default, the library will automatically determine the appropriate format, but this value may be overridden by the :SetDirectoryFormat() method.

 

See Also