Chilkat .NET Ftp Class Reference (C#)

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.

public int NumFilesAndDirs {get; }

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

public bool Passive {get; set; }

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

public string Password {get; set; }

Password for logging into the FTP server.

public int Port {get; set; }

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

public string Proxy {get; set; }

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

public bool UseIEProxy {get; set; }

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

public string Username {get; set; }

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

public string Version {get; }

Version of the component, such as "1.0.0"

Methods

public bool ChangeRemoteDir(string relativeDirPath);

Changes the current remote directory.

public bool Connect();

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

public bool CreateRemoteDir(string dir);

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.

public int DeleteMatching(string remotePattern);

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 "*" wildcard characters can be used. "*" matches 0 or more of any character, and "?" matches exactly 1 of any character.

public bool DeleteRemoteFile(string filename);

Deletes a file on the FTP server.

public bool Disconnect();

Disconnects from the FTP server, ending the current session.

public DateTime GetCreateTime(int index);

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)

public string GetCurrentDirListing(string pattern);

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

public string GetCurrentRemoteDir();

Returns the current remote directory.

public bool GetFile(string remoteFilename, string localFilename);

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

public string GetFilename(int index);

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)

public bool GetIsDirectory(int index);

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)

public DateTime GetLastAccessTime(int index);

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)

public DateTime GetLastModifiedTime(int index);

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)

public byte [] GetRemoteFileBinaryData(string remoteFilename);

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

public string GetRemoteFileTextData(string remoteFilename);

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

public int GetSize(int index);

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

public int MGetFiles(string remotePattern, string localDir);

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.

public int MPutFiles(string pattern);

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

public bool PutFile(string localFilename, string remoteFilename);

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

public bool PutFileFromBinaryData(string remoteFilename, byte [] content);

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

public bool PutFileFromTextData(string remoteFilename, string textData, string charset);

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

public bool RemoveRemoteDir(string dir);

Removes a directory from the FTP server.

public bool RenameRemoteFile(string existingFilename, string newFilename);

Renames a file on the FTP server.

public bool SaveLastError(string filename);

Saves the last error information to an XML formatted file.