Translate page

Close_Method


Sends a request to the QWS3270 window with the specified session ID or session name to close the session.

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

Syntax


C#
StatusCode Close(
	Object sessionID
)
Visual Basic (Declaration)
Function Close ( _
	sessionID As Object _
) As StatusCode
Visual C++
StatusCode Close(
	Object^ sessionID
)
JavaScript
function Close(sessionID);

Parameters

sessionID
Type: System..Object
The session ID or name of the instance to close.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:


Status codeDescription
OkMessage to QWS session with specified session name to close was successfully posted.
InvalidPsIdThe specified session ID or name was invalid.
WHLLUNKNOWNAn unknown error occurred.

Remarks

This method can only be used if the session was started with either the Start(String, String, Char) or the StartSession(String, String) method. If the session was started with the Start(String, String, Char) method, the session parameter must specify the returned session ID. If the session was started with the StartSession(String, String) method, the parameter must specify the session name used to start the session.

See Also


Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.