This method sets options of the host session. Session options that are not set with this method use their default values. Session options set with this method remain in effect until another call sets a new value.

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

Syntax

C#
public StatusCode SetSessionOptions( string options, ref int optionsLength )

Visual Basic (Declaration)
Public Function SetSessionOptions ( _ options As String, _ ByRef optionsLength As Integer _ ) As StatusCode

Visual C++
public: virtual StatusCode SetSessionOptions( String^ options, int% optionsLength ) sealed

JavaScript
function SetSessionOptions(options, optionsLength);

Parameters

options
Type: System..String
String containing the desired session options to set. If more than one session option is set, use a comma or space to separate the session options.

optionsLength
Type: System..Int32
Explicit length of options string. Remains the same as the call value if all session options in the buffer are valid. If the options contain any invalid session options, optionsLength is set to the number of valid session options in options.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
Ok	All of the requested session options set as specified.
WHLLPARAMETERERROR	Data String contains one or more invalid session options.
WHLLSYSERROR	The method failed due to a system error.

Implements

IApplication..SetSessionOptions(String, Int32)

Remarks

See the HLLAPI help file for a detailed explanation on available session parameters and the methods they affect.

Examples

C#

string options = "NOEAB TIMEOUT=4 QUIET AUTORESET";
int length = options.Length;
IApplication app = qws.Application;
if (Ok != app.SetSessionOptions(options, ref length) ||
    length != options.Length)
    // not all options have been set
    reportError(code);

See Also

Application Class

JollyGiant.Emulation Namespace

Send comments on this topic to: Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.

Browser not supported