Xceed .NET Libraries Documentation
SendCustomCommand Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > FtpClient Class : SendCustomCommand Method
The command to send to the FTP server.
Sends a custom command to the FTP server.
Syntax
'Declaration
 
Public Function SendCustomCommand( _

   ByVal command As String _

) As String
'Usage
 
Dim instance As FtpClient

Dim command As String

Dim value As String

 

value = instance.SendCustomCommand(command)
public string SendCustomCommand( 

   string command

)

Parameters

command
The command to send to the FTP server.

Return Value

The reply received from the FTP server in response to the custom command.
Exceptions
ExceptionDescription
Cannot perform the requested operation because the FTP client is in an invalid state.
An error reply was returned by the FTP server.
An I/O error has occurred.
A fatal FTP-specific error has occurred..
Remarks

The SendCustomCommand method is used to send FTP commands. This means that commands you enter using the Windows command-line FTP (such as "dir", "put" or "debug") are not the commands that are actually sent to the FTP server. Although these commands might be recognized by some FTP servers, they are not guaranteed to work!.

When sending a custom FTP command, the local folder separator character will not be replaced by the ServerFolderSeparator to allow the local folder separator character to be sent "as is".

Not all commands are supported by all FTP servers. In order to determine which commands are supported, you can use the SendCustomCommand method to send the "HELP" command. For example: ftp.SendCustomCommand( "HELP" );.

The SendCustomCommand method does not support custom commands that require a data connection such as STOR (SendFile), RETR (ReceiveFile), NLST and LIST (GetFolderContents), etc.

This method is the equivalent of the SendCommand method of the ActiveX version of the Xceed FTP Library.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

FtpClient Class
FtpClient Members