Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »


Retrieves information about the currently active sessions.

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

Syntax


C#
StatusCode GetSessions(
	ref string sessions,
	out int numberOfSessions
)
Visual Basic (Declaration)
Function GetSessions ( _
	ByRef sessions As String, _
	<OutAttribute> ByRef numberOfSessions As Integer _
) As StatusCode
Visual C++
StatusCode GetSessions(
	String^% sessions, 
	[OutAttribute] int% numberOfSessions
)
JavaScript
function GetSessions(sessions, numberOfSessions);

Parameters

sessions
Type: System..String
Buffer to hold session information.
The sessions parameter will on successful return contain session information for each active host session in the following format:


String positionMeaning
1Session ID character.
2 - 9Session long name, always 8 spaces for QWS.
10Session type: "H" for 'host', "P" for 'personal computer.'
11 - 12Size of the presentation space, expressed as a binary number.


numberOfSessions
Type: System..Int32
If the return value is Ok or ParameterError, this will contain the number of active host sessions at the time of the call. Note that there is no guarantee that a session that was open at the time of the call can not be closed or disconnected by the time this method returns.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:


Status codeDescription
OkInformation on host sessions retrieved successfully.
WHLLPARAMETERERRORThe size of the buffer was too small; use the numberOfSessions parameter return value to calculate the correct buffer size.
WHLLSYSERRORA system error occurred.

See Also


Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.




  • No labels