findStringEx Method

Searches the presentation space for the specified text string from the specified start position to the specified end position. If found, it returns true and the start position of the string.

Syntax

C#
Visual Basic
C++/CLI

'Declaration
 
Public Function findStringEx( _ 
   ByVal inText As String, _ 
   ByVal inStartRow As Integer, _ 
   ByVal inStartColumn As Integer, _ 
   ByVal inEndRow As Integer, _ 
   ByVal inEndColumn As Integer, _ 
   ByVal inArea As Integer, _ 
   ByVal inWrap As Integer, _ 
   ByVal inDir As Integer, _ 
   ByVal outRow As MutableInt, _ 
   ByVal outColumn As MutableInt _ 
) As Boolean

'Usage
 
Dim instance As ScreenUPG 
Dim inText As String 
Dim inStartRow As Integer 
Dim inStartColumn As Integer 
Dim inEndRow As Integer 
Dim inEndColumn As Integer 
Dim inArea As Integer 
Dim inWrap As Integer 
Dim inDir As Integer 
Dim outRow As MutableInt 
Dim outColumn As MutableInt 
Dim value As Boolean 
  
value = instance.findStringEx(inText, inStartRow, inStartColumn, inEndRow, inEndColumn, inArea, inWrap, inDir, outRow, outColumn)

public bool findStringEx( 
   string inText,
   int inStartRow,
   int inStartColumn,
   int inEndRow,
   int inEndColumn,
   int inArea,
   int inWrap,
   int inDir,
   MutableInt outRow,
   MutableInt outColumn 
)

public: 
bool findStringEx( 
   String^ inText,
   int inStartRow,
   int inStartColumn,
   int inEndRow,
   int inEndColumn,
   int inArea,
   int inWrap,
   int inDir,
   MutableInt^ outRow,
   MutableInt^ outColumn 
)

Parameters

inText: The text to search for.
inStartRow: The row in which to begin searching.
inStartColumn: The column in which to begin searching.
inEndRow: The row in which to stop searching.
inEndColumn: The column in which to stop searching.
inArea: Reserved. Set to 0.
inWrap: Whether or not to wrap to the top after reaching the end of the presentation space. Possible values include: WRAP_ON and WRAP_OFF
inDir: The direction to search when looking for the string. When searching backwards, searching begins at the end of the selected area. Possible values include: DIRECTION_BACKWARD and DIRECTION_FORWARD.
outRow: The row where the string was found. If the string is not found, the value is set to zero.
outColumn: The column where the string was found. If the string is not found, the value is set to zero.

Return Value

true or false. If the string is found, the value is set to true. Otherwise, it is set to false.

Remarks

Detected field attributes or hidden fields are treated as spaces.

Example

C#
Visual Basic

string inText = "PASSWORD";
int inStartRow = 1;
int inStartCol = 0;
int inEndRow = 12;
int inEndCol = 80;
int inArea = 0;
int inWrap = ScreenUPG.WRAP_ON;
int inDirection = ScreenUPG.DIRECTION_FORWARD;
MutableInt outRow = new MutableInt();
MutableInt outCol = new MutableInt();
            
// Find the string
bool found = screen.findStringEx(inText, inStartRow, inStartCol, inEndRow, inEndCol, inArea, inWrap, inDirection, outRow, outCol);

Dim inText As Integer
Dim inStartRow As Integer
Dim inStartCol As Integer
Dim inEndRow As Integer
Dim inEndCol As Integer
Dim inArea As Integer
Dim inWrap As Integer
Dim inDirection As Integer
Dim outRow As New Mutable.MutableInt
Dim outColumn As New Mutable.MutableInt
Dim found As Boolean
            
inText = PASSWORD
inStartRow = 1
inStartCol = 1
inEndRow = 12
inEndCol = 80
inArea = 0
inWrap = 1
inDirection = 0
            
'Find the string
found = screen.findStringEx(inText, inStartRow, inStartCol, inEndRow, inEndCol, inArea, inWrap, inDirection, outRow, outCol)

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ScreenUPG Class
ScreenUPG Members
findString Method
WRAP_OFF Property
WRAP_ON Property