Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Background Color
coloryellow
IScreen::VBS_GetString


Retrieve the screen contents from the specified position until the end of screen.

 

Background Color
Function VBS_GetString(row As Variant, column As Variant, buffer As Variant, bufsize As Long) As Long

 


Parameters

NoNameTypeOptionalDefaultDescription
1rowVariantNo-

row in the screen where copy is to begin

2

column

Variant

No

-

Column in the screen where copy is to begin

3

buffer

Variant

No

-

String buffer

4

bufsize

Long

No

-

Length of the string to copy

Return Code

Description

JGS_OK

The function was successful

JGS_PARAMETERERROR

Missing or invalid parameter

JGS_NOTCONNECTED

Your application is not currently connected to a valid host session.

JGS_FTXSEGMENTED

The data was successfully copied; host session is waiting for a host response

JGS_INHIBITED

The data was successfully copied; the keyboard is locked

JGS_POSITIONERROR

The position value specified is invalid

JGS_SYSERROR

The function failed due a system error

JGS_MEMORY

Insufficient memory

Sample Code


Background Color
coloryellow


Dim myString as Variant
Dim row as Variant
Dim column as Variant
Dim myLength as Long
Dim result as Long
myLength = 200
row = 18
column = 45
result = screen.VBS_GetString(row, column, myString, myLength)



QWS3270 Automation copyright © Jolly Giant Software Inc. All rights reserved.

...