Verastream SDK .Net Reference
getStringEx Method
Example 



The first row from which to retrieve text.
The first column from which to retrieve text.
The last row from which to retrieve text.
The last column from which to retrieve text.
Reserved. Set to 0.
Whether or not to wrap to the top after reaching the end of the presentation space. Possible values include: WRAP_ON and WRAP_OFF
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".
Reserved. Set to 0.
Returns the visible text from the specified location with attributes matching those specified by inAttr.
Syntax
'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
'Usage
 
Dim instance As ScreenUPG
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 inAttr As Integer
Dim inFlags As Integer
Dim value As String
 
value = instance.getStringEx(inStartRow, inStartColumn, inEndRow, inEndColumn, inArea, inWrap, inAttr, inFlags)

Parameters

inStartRow
The first row from which to retrieve text.
inStartColumn
The first column from which to retrieve text.
inEndRow
The last row from which to retrieve text.
inEndColumn
The last column from which to retrieve text.
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
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#] [VB]
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);
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)
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

See Also