FLStartSession        Method to initiate a FileLink session

Overview

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

C++ Definition

long FLStartSession( CString strSessionName, long nComPort, BOOL bBlocking, BOOL bHidden, CString strCmdLineArgs )

VB Definition

FLStartSession( SessionName As String, ComPort As Long, Blocking As Long, Hidden As Long, Args As String ) As Long

Return Value

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

Returns FL_ERROR_SUCCESS if a named session is successfully started.

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

Returns FL_ERROR_CANNOT_CREATE if a session with FileLink 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 FileLink.

nComPort / ComPort

A numeric value that specifies which port (1 - 48, where 1 - 48 correspond to COM1 - COM48) to associate with the new session.

bBlocking / Blocking

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

bHidden / Hidden

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

strCmdLineArgs / Args

A string defining optional command line arguments to pass FileLink when it is launched.

Remarks

This method returns when FileLink has been launched and the session name is established.