Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Gets status information about the specified window.

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

Syntax

C#
StatusCode GetStatus(
	Object sessionID,
	ref int status,
	ref int x,
	ref int y,
	ref int width,
	ref int height,
	ref int zorder
)


Visual Basic (Declaration)
Function GetStatus ( _
	sessionID As Object, _
	ByRef status As Integer, _
	ByRef x As Integer, _
	ByRef y As Integer, _
	ByRef width As Integer, _
	ByRef height As Integer, _
	ByRef zorder As Integer _
) As StatusCode


Visual C++
StatusCode GetStatus(
	Object^ sessionID, 
	int% status, 
	int% x, 
	int% y, 
	int% width, 
	int% height, 
	int% zorder
)


JavaScript
function GetStatus(sessionID, status, x, y, width, height, zorder);


Parameters

sessionID
Type: System..::.ObjectThe Object
The session ID of the window which to retrieve status for.

status
Type: System..::.Int32 %Window
Window status (minimized, maximized, visible, etc.).

x
Type: System..::.Int32 %The
The x position of the window.

y
Type: System..::.Int32 %The
The y position of the window.

width
Type: System..::.Int32 %The
The width of the window.

height
Type: System..::.Int32 %The
The height of the window.

zorder
Type: System..::.Int32 %The
The z-order of the window.
 

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

...