Interface IGuiSession

Namespace

HP.LFT.SDK.SAP.GUI

Assembly

HP.LFT.SDK.dll

A SAP GUI for Windows session.

public interface IGuiSession : ITestObject, ITestObjectDescriber, ISupportsNativeObject

Inherited Members

ITestObject.GetDescription()

ITestObject.SetDescription(IDescription)

ITestObject.FindChildren<TChild>(IDescription)

ITestObject.Exists()

ITestObject.Exists(uint)

ITestObject.GetSnapshot()

ITestObject.Highlight()

ITestObject.HighlightMatches<TChild>(IDescription)

ITestObject.GetTextLocations(string)

ITestObject.GetTextLocations(string, Rectangle)

ITestObject.GetVisibleText()

ITestObject.GetVisibleText(Rectangle)

ITestObject.VerifyImageExists(Image, byte)

ITestObject.VerifyImageMatch(Image, byte, byte)

ITestObject.VerifyImageMatch(Image, ImageMaskArea, byte, byte)

ITestObject.CallFTMethod(string, params object[])

ITestObject.CallFTMethod<TResult>(string, params object[])

ITestObject.Parent

ITestObject.DisplayName

ITestObjectDescriber.Describe<TChild>(IDescription)

ISupportsNativeObject.NativeObject

Extension Methods

TestObjectExtensions.WaitUntilExists<T>(T)

TestObjectExtensions.WaitUntilExists<T>(T, int)

TestObjectExtensions.WaitUntil<T>(T, Func<T, bool>)

TestObjectExtensions.WaitUntil<T>(T, Func<T, bool>, int)

Properties

ActiveWindow

The name of the window that has focus.

string ActiveWindow { get; }

Property Value

string

ApplicationServer

The name of the application server. Applies only when the connection specifies an application server and is not using load balancing.

string ApplicationServer { get; }

Property Value

string

Client

The client selected on the login screen.

string Client { get; }

Property Value

string

CodePage

The code page for this session.

long CodePage { get; }

Property Value

long

Flushes

The number of flushes or passes of data during server communication to the client.

long Flushes { get; }

Property Value

long

Group

Login group information. Applies only when connection is using load balancing.

string Group { get; }

Property Value

string

Id

The session's unique identifier in text format.

string Id { get; }

Property Value

string

InterpretationTime

The time, in milliseconds, it takes for the client to interpret the information received from the server.

long InterpretationTime { get; }

Property Value

long

Language

The language the user is working in.

string Language { get; }

Property Value

string

MessageServer

The name of the message server. Applies only when connection is using load balancing.

string MessageServer { get; }

Property Value

string

Name

The name of the session.

string Name { get; }

Property Value

string

Program

The name of the SAP source program that is executing.

string Program { get; }

Property Value

string

ResponseTime

The server response time in milliseconds.

long ResponseTime { get; }

Property Value

long

RoundTrips

The number of communications between client and server while the client is locked and waiting for data from the server.

long RoundTrips { get; }

Property Value

long

ScreenNumber

The number of the displayed screen.

long ScreenNumber { get; }

Property Value

long

SystemName

The name of the SAP system.

string SystemName { get; }

Property Value

string

SystemNumber

The system number. Applies only when connection specifies an application server and is not using load balancing.

long SystemNumber { get; }

Property Value

long

Transaction

The transaction the user is executing.

string Transaction { get; }

Property Value

string

Type

The GUI component type.

ComponentType Type { get; }

Property Value

ComponentType

User

The user name.

string User { get; }

Property Value

string

Methods

Close()

Closes the SAP GUI for Windows session without displaying a warning message.

void Close()

Remarks

You can invoke this method at the end of an action or test iteration to close sessions that were opened during the test run. This ensures that each iteration begins with the same number of open SAP Gui for Windows sessions.

Reset()

Navigates to the session initial screen.

void Reset()

Remarks

We recommend using this method to ensure that tests are rerun from the initial screen of the session.

Reset(string)

Navigates to the specified transaction.

void Reset(string transactionCode)

Parameters

transactionCode string

the transaction to navigate to.

Sync()

Suspends execution until the SAP GUI for Windows session is available.

void Sync()

Sync(long)

Suspends execution until the SAP GUI for Windows session is available or until timed out.

void Sync(long timeOut)

Parameters

timeOut long

milliseconds.

Remarks

After time-out, the test run continues regardless of the session status.

You can use this method when invoking a new session from an existing session or when moving from a session that is open on one server to a new session on a different server.