Translate page

Start Method (String, String, String, Int32, String String)



Start a QWS3270 program and attempt to connect to the specified host on the specified port number. You can also request a terminal type and logical unit (LU) name.

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

Syntax


C#
public StatusCode Start(
	string qwsPath,
	string hostname,
	ref string sessionID,
	int port,
	string termType,
	string luName
)
Visual Basic (Declaration)
Public Function Start ( _
	qwsPath As String, _
	hostname As String, _
	ByRef sessionID As String, _
	port As Integer, _
	termType As String, _
	luName As String _
) As StatusCode
Visual C++
public:
virtual StatusCode Start(
	String^ qwsPath, 
	String^ hostname, 
	String^% sessionID, 
	int port, 
	String^ termType, 
	String^ luName
) sealed
JavaScript
function Start(qwsPath, hostname, sessionID, port, termType, luName);

Parameters

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

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

sessionID
Type: System..String
One character 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.

port
Type: System..Int32
The port number the host is listening on for incoming connections.

termType
Type: System..String
Requested terminal type string (IBM-3278-2-E"). If this parameter is null or empty, the program default terminal type will be used.

luName
Type: System..String
Logical Unit name requested. This can be null or an empty string.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:


Status codeDescription
OkThe new program instance was started successfully.
InvalidPsIdThe requested session ID was not a valid (A-Z,a-z) character.
WHLLTOOMANYSESSIONSAll 26 session IDs are already in use.
WHLLSTARTPROCFAILEDUnable to start the new process.
WHLLUNKNOWNAn unknown error occurred.

Implements

IApplication...Start(String, String, String, Int32, String, String)

Examples

Start the QWS3270 PLUS program and connect to a host, using the default port and terminal type.
C#
string qwsPath = @"C:\Program Files\QWS3270 PLUS\qws3270p.exe";
string hostName = @"jollygiant.dnsalias.com";
string termType = @"IBM-3279-4-E";
string luName = @"myluname";
string id = "A";
int port = 1023;
StatusCode sc = qws.Start(qwsPath, hostName, ref id, port, termType, luName);
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


ExceptionCondition
System..::.ArgumentExceptionProgram path or host name are null or empty strings.
System.IO..::.FileNotFoundExceptionThe file specified in qwsPath could not be found.

See Also


Send comments on this topic to: Jolly Giant Software


Copyright 2009 by Jolly Giant Software, Inc.