Rocket® InfoConnect Desktop (formerly a product of Micro Focus or formerly a product of Open Text) documentation, created before Rocket Software acquired certain products from OpenText, may include outdated references to "Micro Focus" or "OpenText", both of which are trademarks of OpenText or its affiliates. Rocket Software is not affiliated with Micro Focus or OpenText and has since rebranded these products as Rocket® products. You may also encounter outdated links in this documentation. If you do, please contact Rocket Support (support@rocketsoftware.com) for assistance.
Specifies the user name. If this argument is null or empty, InfoConnect uses the current
FTP User Name (which can be set using the FTP tab of the File Transfer dialog box,
or using the FTPUserName property). If no FTP User Name has been set, InfoConnect
displays the FTP Log In dialog box unless FTPServerOptions.NoLoginDialog is specified
in the Options argument. If FTPServerOptions.NoLoginDialog is specified, FTPStartServer
returns an error when UserName is not specified and no FTP User Name has been set.
If FTPServerOptions.Anonymous is specified in the Options argument, the UserName argument
is ignored.
Specifies the FTP password. If this argument is null or empty, InfoConnect uses the
current FTP Password (which can be set using the FTP tab in the File Transfer dialog
box, or using the FTPPassword property). If no password has been set, InfoConnect
displays the FTP Log In dialog box unless FTPServerOptions.NoLoginDialog is specified
in the Options argument. If FTPServerOptions.NoLoginDialog is specified, FTPStartServer
generates an error when Password is not specified and no password has been set.
Specifies the host name or IP address. If this argument is null or empty, the current
value of FTPHostName is used.
Specifies additional, non-default behavior for the method. The possible values are:
FTPServerOption.Anonymous Specifies that InfoConnect should use anonymous FTP when
performing this transfer. FTPServerOption.NoLogInDialog Specifies that no FTP Log
In dialog should appear if the FTP user name or password is not supplied. You can
combine the two options by adding these values.
FTPStartServer Method
In This Topic
Connects to a host server in preparation for FTP file transfers. Use FTPSendFile and
FTPReceiveFile to transfer files. Use FTPStopServer to disconnect from the host FTP
server. If your settings file is not already configured for FTP protocol, use TransferDefaultProtocol
to set the transfer protocol, and TransferPreset to set the host server type. Most
menu commands and all toolbar buttons are disabled when InfoConnect is in server mode.
Syntax
'Declaration
Function FTPStartServer( _ ByVal userName As String, _ ByVal password As String, _ ByVal hostName As String, _ ByVal options As FTPServerOption _ ) As ReturnCode
'Usage
Dim instance As IFileTransfer Dim userName As String Dim password As String Dim hostName As String Dim options As FTPServerOption Dim value As ReturnCode value = instance.FTPStartServer(userName, password, hostName, options)
ReturnCode FTPStartServer( string userName, string password, string hostName, FTPServerOption options )
Parameters
- userName
- Specifies the user name. If this argument is null or empty, InfoConnect uses the current FTP User Name (which can be set using the FTP tab of the File Transfer dialog box, or using the FTPUserName property). If no FTP User Name has been set, InfoConnect displays the FTP Log In dialog box unless FTPServerOptions.NoLoginDialog is specified in the Options argument. If FTPServerOptions.NoLoginDialog is specified, FTPStartServer returns an error when UserName is not specified and no FTP User Name has been set. If FTPServerOptions.Anonymous is specified in the Options argument, the UserName argument is ignored.
- password
- Specifies the FTP password. If this argument is null or empty, InfoConnect uses the current FTP Password (which can be set using the FTP tab in the File Transfer dialog box, or using the FTPPassword property). If no password has been set, InfoConnect displays the FTP Log In dialog box unless FTPServerOptions.NoLoginDialog is specified in the Options argument. If FTPServerOptions.NoLoginDialog is specified, FTPStartServer generates an error when Password is not specified and no password has been set.
- hostName
- Specifies the host name or IP address. If this argument is null or empty, the current value of FTPHostName is used.
- options
- Specifies additional, non-default behavior for the method. The possible values are: FTPServerOption.Anonymous Specifies that InfoConnect should use anonymous FTP when performing this transfer. FTPServerOption.NoLogInDialog Specifies that no FTP Log In dialog should appear if the FTP user name or password is not supplied. You can combine the two options by adding these values.
See Also