Translate page

GetStatus Method (Object, WindowStatus)


Retrieve information about the application's main window.

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

Syntax

C#
[ComVisibleAttribute(false)]
StatusCode GetStatus(
	Object sessionID,
	ref WindowStatus status
)
Visual Basic (Declaration)
<ComVisibleAttribute(False)> _
Function GetStatus ( _
	sessionID As Object, _
	ByRef status As WindowStatus _
) As StatusCode
Visual C++
[ComVisibleAttribute(false)]
StatusCode GetStatus(
	Object^ sessionID, 
	WindowStatus% status
)
JavaScript
function GetStatus(sessionID, status);


Parameters

sessionID
Type: System..Object
Session ID; this can be a one character string, a single character, or an integer type in the valid character range.

status
Type: JollyGiant.Emulation..WindowStatus
Window status class object receiving requested status information.

Return Value

The return value is a StatusCode specifying the success or failure of the method.

Status codeDescription
OkThe method was successful.
WHLLNOTCONNECTEDAn invalid presentation space was specified, or was not connected for window services.
WHLLPARAMETERERRORAn invalid option was specified.
WHLLSYSERRORThe method failed due to a system error.
WHLLPSENDEDThe session has stopped.

Exceptions


ExceptionCondition
System.Runtime.InteropServices..::.InvalidOleVariantTypeExceptionThe sessionID object could not be converted to a valid one-character session ID, or the value was out of range.

See Also


IWindow Interface
GetStatus Overload
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.