Translate page

SetName.Method


Sets the application's main window title.

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

Syntax

C#
StatusCode SetName(
	Object sessionID,
	string title
)
Visual Basic (Declaration)
Function SetName ( _
	sessionID As Object, _
	title As String _
) As StatusCode
Visual C++
StatusCode SetName(
	Object^ sessionID, 
	String^ title
)
JavaScript
function SetName(sessionID, title);


Parameters

sessionID
Type: System..Object
Session ID; this can be a one character string, a single character, or an integer in the valid character range.

title
Type: System..String
The new window title to set; maximum length for the new title is 60 characters.

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 the specified presentation space was not connected for window services.
HLLPARAMETERERRORAn invalid option was specified.
WHLLSYSERRORThe method failed due to a system error.
WHLLPSENDEDThe session 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
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.