ChilkatFtp ActiveX Reference (Visual Basic)

ChilkatFtp

Free and Unsupported File Transfer Protocol (FTP) Component.

Reference Index
Chilkat Home
Example Programs

Properties

Hostname
IsConnected
LastErrorHtml
LastErrorText
LastErrorXml
ListPattern
NumFilesAndDirs
Passive
Password
Port
Proxy
UseIEProxy
Username
Version

Methods

ChangeRemoteDir
Connect
CreateRemoteDir
DeleteMatching
DeleteRemoteFile
Disconnect
GetCreateTime
GetCurrentDirListing
GetCurrentRemoteDir
GetFile
GetFilename
GetIsDirectory
GetLastAccessTime
GetLastModifiedTime
GetRemoteFileBinaryData
GetRemoteFileTextData
GetSize
MGetFiles
MPutFiles
PutFile
PutFileFromBinaryData
PutFileFromTextData
RemoveRemoteDir
RenameRemoteFile
SaveLastError


Properties

Hostname As String

The FTP server hostname.

IsConnected As Long (read-only)

Returns true if currently connected and logged into an FTP server, otherwise returns false.

LastErrorHtml As String (read-only)

Error information in HTML format for the last method called.

LastErrorText As String (read-only)

Error information in plain-text format for the last method called.

LastErrorXml As String (read-only)

Error information in XML format for the last method called.

ListPattern As String

A wildcard pattern, defaulting to "*" that determines the files and directories included in the following properties and methods: NumFilesAndDirs, GetCreateTime, GetFilename, GetIsDirectory, GetLastAccessTime, GetModifiedTime, GetSize.

NumFilesAndDirs As Long (read-only)

The number of files and sub-directories in the current remote directory that match the ListPattern. (The ListPattern defaults to "*", so unless changed, this is the total number of files and sub-directories.)

Passive As Long

Set to true for FTP to operate in passive mode, otherwise set to false for non-passive (the default).

Password As String

Password for logging into the FTP server.

Port As Long

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

Proxy As String

The name of a proxy server when accessing FTP via a proxy .

UseIEProxy As Long

Set this property to true to use the FTP proxy configured for Internet Explorer.

Username As String

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

Version As String (read-only)

Version of the component, such as "1.0.0"

Methods

ChangeRemoteDir(relativeDirPath As String) As Long

Changes the current remote directory.

Connect() As Long

Connects and logs in to the FTP server using the username/password provided in the component properties.

CreateRemoteDir(dir As String) As Long

Creates a directory on the FTP server. Returns true for success, false for failure. If the directory already exists, a new one is not created and false is returned.

DeleteMatching(remotePattern 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.

DeleteRemoteFile(filename As String) As Long

Deletes a file on the FTP server.

Disconnect()

Disconnects from the FTP server, ending the current session.

GetCreateTime(index As Long) As Date

Returns the create time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

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.

GetCurrentRemoteDir() As String

Returns the current remote directory.

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

Copies a file from the FTP server to the local filesystem. Returns true for success and false for failure.[

GetFilename(index As Long) As String

Returns the filename for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

GetIsDirectory(index As Long) As Long

Returns1 for a sub-directory and 0 for a file, for the Nth entry in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

GetLastAccessTime(index As Long) As Date

Returns the last access time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

GetLastModifiedTime(index As Long) As Date

Returns the last modified time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

GetRemoteFileBinaryData(remoteFilename As String) As Variant

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

GetRemoteFileTextData(remoteFilename As String) As String

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

GetSize(index As Long) As Long

Returns the size of the Nth remote file in the current directory.

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.

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.[

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

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

PutFileFromBinaryData(remoteFilename As String, binaryData As Variant) As Long

Creates a file on the remote server containing the data passed in a byte array. Returns true for success, false for failure.

PutFileFromTextData(remoteFilename As String, textData As String) As Long

Creates a file on the remote server containing the data passed in a string. Returns true for success, false for failure.[

RemoveRemoteDir(dir As String) As Long

Removes a directory from the FTP server.

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

Renames a file on the FTP server.

SaveLastError(filename As String)

Saves the last error information to an XML formatted file.

Copyright 2000-2006 Chilkat Software, Inc.