Versions Compared

Key

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

...

Function GetStatus(Session As String, win_stat As WindowStatus) As Long

Parameters

NoNameTypeOptionalDefaultDescription
1SessionStringNo-

One character session ID

2

win_stat

WindowStatus

No

-

Structure to receive status information

Return Code

Description

JGS_OK

The function was successful

JGS_NOTCONNECTED

Your application is not currently connected to any valid session

JGS_SYSERROR

The function failed due to a system error

JGS_UNAVAILABLE

The session is already in use by another application

JGS_PARAMETERERROR

Missing or invalid parameter

JGS_PSENDED

The session has ended

Sample Code

Dim mySession as String
Dim result as Long
Dim stat as WindowStatus
mySession = "E"
result = win.GetStatus(mySession, stat)
If result = JGS_OK then
  stat.status = a 2 byte integer value that contains the status information
  stat.coords = the window coordinates

...