Start a QWS3270 program and attempt to connect to the specified host.

Namespace: JollyGiant.Emulation
Assembly: JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
[ComVisibleAttribute(false)] public StatusCode Start( string qwsPath, string hostname, ref char sessionID )

Visual Basic (Declaration)
<ComVisibleAttribute(False)> _ Public Function Start ( _ qwsPath As String, _ hostname As String, _ ByRef sessionID As Char _ ) As StatusCode

Visual C++
[ComVisibleAttribute(false)] public: virtual StatusCode Start( String^ qwsPath, String^ hostname, wchar_t% sessionID ) sealed

JavaScript
function Start(qwsPath, hostname, sessionID);

Parameters

qwsPath Type: System..::.StringThe fully qualified path to the QWS program to use.

hostname Type: System..::.StringHost name or IP address of the host you want to connect to.

sessionID Type: System..::.Char %The session ID to use. The specified ID is only a request to the program. If the requested ID is already in use by another program instance, the last unused ID (Z-A) will be selected and returned in this parameter. You will need this ID to establish a logical connection to the session before you can exchange information with it.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
Ok	The new program instance was started successfully.
InvalidPsId	The requested session ID was not a valid (A-Z,a-z) character.
WHLLTOOMANYSESSIONS	All 26 session IDs are already in use.
WHLLSTARTPROCFAILED	Unable to start the new process.
WHLLUNKNOWN	An unknown error occurred.

Implements

IApplication..Start(String, String, Char)

Examples

Start the QWS3270 PLUS program and connect to a host, using the default port and terminal type.

CopyC#

string qwsPath = @"C:\Program Files\QWS3270 PLUS\qws3270p.exe";
string hostName = @"jollygiant.dnsalias.com";
char id = 'A';
StatusCode sc = qws.Start(qwsPath, hostName, ref id);

The id may or may not be 'A' after the call, depending on whether that ID was already in use by another session. Check the status code and the id after the call.

Exceptions

Exception	Condition
System..::.ArgumentException	Program path or host name are null or empty strings.
System.IO..::.FileNotFoundException	The file specified in qwsPath could not be found.

Start Method (String, String, Char)