DOWNLOAD

Docs: Certificate • Crypt • XML • ASP XML • Mail • MHT • S/MIME • Zip • XMsg • SSL • RTC • Charset • CkStringArray • CkData • ChilkatCSP • Log

Help for Creating Objects in ASP

Reference

FTP Properties

Hostname As String read/write

The FTP server hostname. [top]

IsConnected As Long read-only

Returns 1 if currently connected and logged into an FTP server, otherwise returns 0. [top]

Password As String read/write

Password for logging into the FTP server.[top]

Port As Long read/write

Port number. Automatically defaults to the default port for the FTP service. [top]

 

Username As String read/write

Username for logging into the FTP server. Defaults to "anonymous".[top]

 

Version As String read-only

Version of the component, such as "1.0.0"[top]

FTP Methods

ChangeRemoteDir( remoteDir As String) As Long

Changes the current remote directory. Returns 1 for success, 0 for failure. [top]

 

Connect( ) As Long

Connects and logs into the FTP server using the username/password provided in the component properties. Returns 1 for success, 0 for failure.[top]

 

CreateRemoteDir( filename As String ) As Long

Creates a directory on the FTP server. Returns 1 for success, 0 for failure. If the directory already exists, a new one is not created and a 0 is returned. [top]

 

DeleteMatching( pattern As String ) As Long

Deletes all the files in the current remote FTP directory matching the pattern. Returns the number of files deleted, or -1 for failure. The pattern is a string such as "*.txt", where any number of "*" or "?" wildcard characters can be used. "*" matches 0 or more of any character, and "?" matches exactly 1 of any character. [top]

 

DeleteRemoteFile( filename As String ) As Long

Deletes a file on the FTP server. Returns 1 for success, 0 for failure.[top]

 

Disconnect( )

Disconnects from the FTP server, ending the current session. [top]

 

GetCurrentDirListing( pattern As String ) As String

Returns (in XML format) the files and directories in the current directory matching the pattern. Passing "*.*" will return all the files and directories. [top]

 

GetCurrentRemoteDir( ) As String

Returns the current remote directory.[top]

 

GetFile( remoteFilename As String, localFilename As String) As Long

Copies a file from the FTP server to the local filesystem. Returns 1 for success and 0 for failure.[top]

 

GetRemoteFileBinaryData( remoteFile name As String ) As Variant

Returns the contents of a remote file. A null is returned on failure. [top]

 

GetRemoteFileTextData( remoteFilename As String ) As String

Returns the contents of a remote file. A null is returned on failure.[top]

 

MGetFiles( remotePattern As String, localDir As String) As Long

Copies all the files in the current remote FTP directory to a local directory. To copy all the files in a remote directory, set remotePattern to "*.*" The pattern can contain any number of "*" or "?" characters where "*" matches 0 or more of any character, and "?" matches any single character. The return value is the number of files transferred, and on error, a value of -1 is returned. Detailed information about the transfer can be obtained from the XML log.[top]

 

MPutFiles( pattern As String ) As Long

Copies all the files matching pattern on the local computer to the current remote FTP directory. The pattern parameter can include directory information, such as "C:/my_dir/*.txt" or it can simply be a pattern such as "*.*" that matches the files in the application's current directory. Subdirectories are not recursed. The return value is the number of files copied, with a value of -1 returned for errors. Detailed information about the transfer can be obtained from the XML log.[top]

 

PutFile( localFilename As String, remoteFilename As String) As Long

Copies a local file to the current directory on the FTP server.[top]

 

PutFileFromBinaryData( filename As String, fileData As Variant ) As Long

Creates a file on the remote server containing the data passed in fileData. Returns 1 for success, 0 for failure. [top]

 

PutFileFromTextData( filename As String, fileData As String ) As Long

Creates a file on the remote server containing the data passed in fileData. Returns 1 for success, 0 for failure.[top]

 

RemoveRemoteDir( dir As String ) As Long

Removes a directory from the FTP server. Returns 1 for success, 0 for failure.[top]

 

RenameRemoteFile( oldFilename As String, newFilename As String ) As Long

Renames a file on the FTP server. Returns 1 for success, 0 for failure. [top]

 

SaveXmlLog( filename As String )

Saves the XML error log to a file. [top]

 

FTP Events

GetProgress( percentDone As Long )

This event is fired periodically when the GetFile, GetRemoteFileTextData, and GetRemoteFileBinaryData methods are downloading a file from the FTP server. [top]

 

PutProgress( percentDone As Long )

This event is fired periodically when the PutFile, PutFileFromBinaryData, and PutFileFromTextData methods are uploading a file to the FTP server. [top]