autECLPS.WaitForString

<< Click to Display Table of Contents >>

Navigation:  Support for IBM® Personal Communications™ macros > autECLPS >

autECLPS.WaitForString

Description

Waits until the specified text appears on the specified screen location.
Search string is case-sensitive.

Syntax

autECLSession.autECLPS.WaitForString(str, row, col, [optional] TimeOut, [optional] WaitForIr, [optional] bCaseSens)

Parameters

Part

Type

Description

str

String

Required. The text string that you want to wait for.

row

Integer

Required. The row where you expect the string to appear.
Unlike with IBM Personal Communications,  this parameter is not optional and value 0 for entire screen searches is not supported

col

Integer

Required. The column where you expect the string to appear
Unlike with IBM Personal Communications this parameter is not optional and value 0 for entire screen searches is not supported.

TimeOut

Integer

Optional. Specifies the maximum length of time in milliseconds to wait.
The default is 30 second or the value set by SetTimeoutValue.

WaitForIr

Boolean

Optional. If this value is true, after meeting the wait condition the function will wait until the session is ready to accept input.
Default value is False. This parameter is ignored by Quick3270

bCaseSens

Boolean

Optional. If this value is True, the wait condition is verified as case-sensitive.
Default value is False. This parameter is ignored by Quick3270

Returns

The function returns True if the condition is met or False if the Timeout value is exceeded.