Overview

Method to initiate a named session between Robo-FTP and a user-written application.

C++ Definition

long RoboStartSession( CString strSessionName, BOOL bBlocking, BOOL bHidden, CString strCmdLineArgs )

VB Definition

RoboStartSession( SessionName As String, Blocking As Long, Hidden As Long, Args As String ) As Long

C# Definition

Int RoboStartSession( String strSessionName, Int bBlocking, Int bHidden, String strCmdLineArgs )

VB.NET Definition

RoboStartSession( SessionName As String, Blocking As Integer, Hidden As Integer, Args As String ) As Integer

Return Value

The numeric result code returned to indicate the success or failure in initiating a named session with Robo-FTP.

Returns ROBO_ERROR_SUCCESS if a named session is successfully started.

Returns ROBO_ERROR_SESSION_EXISTS if a session with the same name already exists.

Returns ROBO_ERROR_CANNOT_CREATE if a session with Robo-FTP cannot be created.

See COM/OLE Return Codes below for a complete list of possible return values.

Parameters

strSessionName / SessionName

A string defining the session name. Each unique session loads a separate instance of Robo-FTP.

bBlocking / Blocking

A boolean that when TRUE results in subsequent RoboSendCommand() method calls made during the session being blocking calls. If FALSE, each RoboSendCommand is non-blocking.

bHidden / Hidden

A boolean that when TRUE results in Robo-FTP being loaded and run invisibly. If FALSE, the Robo-FTP window appears as it would normally.

strCmdLineArgs/ Args

A string defining optional command line arguments to pass Robo-FTP when it is launched.

Remarks

This method returns when Robo-FTP has been launched and the session name is established.

See also: COM Programming Reference