SilkKDTInitSession Function

Action

The SilkKDTInitSession function connects to a Windows Terminal Server session and opens a remote desktop user session. When the connection is established, the JVM is loaded and the keyword-driven test is set up. If no user name or password are provided, the function uses the user name and password that are saved in the profile settings. If you run the test on your local console, do not set user credentials in the profile settings or the script.

Note: Color depth settings defined using this function override profile settings that were configured in the profile settings: Profile settings > GUI-Level Testing > General > Session settings. When the optional uColorDepth parameter is omitted, the profile settings are used. The default color depth setting is 16 bit.

The server may limit maximum color depth. The client cannot force a color depth setting that is higher than is supported by the server. See the Terminal Services Configuration documentation for details about the color depth limitations of your server.

By default SilkKDTInitSession raises an error with the severity SEVERITY_PROCESS_EXIT if the function fails to start a valid session. The severity of that error can be adjusted by a custom event handler function (see "Event Handler Section"). When an error with SEVERITY_PROCESS_EXIT occurs the rest of the script is ignored and no unsaved results data or measurements will be saved.

Include file

SilkTest.bdh

Syntax

SilkKDTInitSession( in sUser          : string optional,
                    in sPassword      : string optional,
                    in uColorDepth    : number optional,
                    in uDesktopWidth  : number optional,
                    in uDesktopHeight : number optional ): boolean;

Return value

true if successful
false otherwise

Parameter	Description
sUser	Optional: The user name of the remote desktop user. If no user name or password are provided, the function uses the user name and password that are saved in the profile settings.
sPassword	Optional: The password of the remote desktop user. If no username or password are provided, the function uses the user name and password that are saved in the profile settings.
uColorDepth	Optional: The remote session's color depth setting. The default color-depth setting is 16 bit. Possible values are one of following constants of StAutomation.bdh: ST_COLOR_256 := 8; ST_COLOR_15bit := 15; ST_COLOR_16bit := 16; ST_COLOR_24bit := 24; ST_COLOR_32bit := 32;
uDesktopWidth	Optional: The remote session's screen width resolution size in pixels. Default is 1024.
uDesktopHeight	Optional: The remote session's screen height resolution size in pixels. Default is 768.

Example

dcltrans
  transaction TInit
  begin
    AttributeGetString("GLTusername", username);
    AttributeGetString("GLTpassword", password);
    SilkKDTInitSession(username, password);
    SilkTestSetTinkTime(5.0);
  end TInit;
	
  transaction Ttest
  var
    dataset : list of string;
  begin
    SilkKDTExecuteTest("library.zip", "KDTTest", dataset, "KDTTest_Timer");
  end TTest;