Returns the visible text from the specified location with attributes matching those specified by inAttr.


Namespace: ScreenUPG
Assembly: ScreenUPG (in ScreenUPG.dll)

Syntax

Visual Basic (Declaration)
Public Function getStringEx( _ 
   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 inAttr As Integer,  _ 
   ByVal inFlags As Integer _ 
) As String
C#
public string getStringEx(
   int inStartRow,
   int inStartColumn,
   int inEndRow,
   int inEndColumn,
   int inArea,
   int inWrap,
   int inAttr,
   int inFlags
)
C++
public:
 String getStringEx(
   int inStartRow,
   int inStartColumn,
   int inEndRow,
   int inEndColumn,
   int inArea,
   int inWrap,
   int inAttr,
   int inFlags
) sealed 
J#
public string getStringEx(
   int inStartRow,
   int inStartColumn,
   int inEndRow,
   int inEndColumn,
   int inArea,
   int inWrap,
   int inAttr,
   int inFlags
)
JScript
public  function getStringEx(
   inStartRow : int,
   inStartColumn : int,
   inEndRow : int,
   inEndColumn : int,
   inArea : int,
   inWrap : int,
   inAttr : int,
   inFlags : int
) : String

Parameters

inStartRow
The first row from which to retrieve text.
inStartColumn
The first column from which to retrieve text.
inEndRow
inEndColumn
inArea
inWrap
inAttr
The type of fields to retrieve. You can create multiple options with the logical OR operator to create various combinations. For example, SCREENATTR_UNPROTECTED" | SCREENATTR_VISIBLE" returns only unprotected visible fields. Possible values include: SCREENATTR_ANY", SCREENATTR_HIDDEN", SCREENATTR_PROTECTED", SCREENATTR_UNPROTECTED" and SCREENATTR_VISIBLE".
inFlags
Reserved. Set to 0.

Return Value

The text string from the presentation space.

Remarks

If inStartRow and inStartColumn are zero, the entire presentation space is returned.

Example

[C#]

 Copy Code
            int inStartRow = 1;
            int inStartColumn = 1;
            int inEndRow = 12;
            int inEndColumn = 10;
            int inArea = 0;
            int inWrap = ScreenUPG.ScreenUPG.WRAP_ON;
            int inAttr = ScreenUPG.ScreenUPG.SCREENATTR_PROTECTED;
            
            'Get the text string starting at the home position from protected fields
            string visibleString = screen.getString(inStartRow, inStartColumn, inEndRow, inEndColumn, inArea, inWrap, inAttr);
            
[VB]
 Copy Code
            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 visibleString As String
            
            inStartRow = 1
            inStartColumn = 1
            inEndRow = 12
            inEndColumn = 10
            inWrap = 1
            inArea = 0
            inAttr = 1
            
            'Get the text string starting at the home position from protected fields
            visibleString = screen.getString(inStartRow, inStartColumn, inEndRow, inEndColumn, inArea, inWrap, inAttr)
            

See Also