querySessions

Top  Previous  Next

 

The querySessions function returns an array of objects, each of them containing the short name and long name of existing host sessions.

 

3270

5250

Yes

Yes

 

 

Prerequisite Calls

 

There are no prerequisite calls for this function.

 

 

Call Parameters

 

This function does not take any call parameters.

 

 

Return Properties

 

Property name

Explanation

returnCode

A numeric code indicating the execution status of the function.

sessions

An array of objects containing short name and long name of existing host sessions. For further reference on the 'sessions' property, see the table below.

 

 

Return Code

 

Value of 'returnCode' property is always 0.

 

 

'sessions' Property

 

Property name

Explanation

shortName

A 1-character presentation space short name (PSID)

longName

Host session long name (same as profile name; or, if profile not set, same as short name)

 

Remarks

 

1.This function is equivalent to HLLAPI Function Number 10.