Searches the emulator screen for a string until the string is found, or until the timeout expires.

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

Syntax

C#
public StatusCode WaitForString( string waitString, int timeout )

Visual Basic (Declaration)
Public Function WaitForString ( _ waitString As String, _ timeout As Integer _ ) As StatusCode

Visual C++
public: virtual StatusCode WaitForString( String^ waitString, int timeout ) sealed

JavaScript
function WaitForString(waitString, timeout);

Parameters

waitString
Type: System.String
The string to search the screen for.

timeout
Type: System.Int32
Number of seconds to wait for the string to appear before returning.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
Ok	The string was found before the timeout expired.
WHLLNOTCONNECTED	Your application is not currently connected to a session (see Connect(Object)).
WHLLNOFIELD	The specified string was not found on the host presentation space before the timeout expired.
WHLLPARAMETERERROR	You either specified an empty string to search for, or a the timeout value of 0 or less.
WHLLPOSITIONERROR	Specified screen position value is invalid.
WHLLSYSERROR	The method failed due to a system error.

Implements

IQWS3270.WaitForString(String, Int32)

Remarks

The host presentation space can contain nulls in positions where spaces are displayed, in which case a string containing spaces may not be found, even if the string is visible on the screen.

See Also

QWS3270 Class
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.

Browser not supported