Translate page

GetStringWithAttribs (Method)


IScreen::GetStringWithAttribs

Retrieve the text and attributes from specified position until the end of screen.

Function GetStringWithAttribs(cursor As CursorPos, buffer As String, bufsize As Long) As Long

Parameters

NoNameTypeOptionalDefaultDescription
1cursorCursorPosNo-

Position in the screen where copy is to begin

2bufferStringNo-

String buffer

3

bufsize

Long

No

-

Size of string buffer

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


 

Dim myString as String * 400
Dim myPos as CursorPos
Dim myLength as Long
Dim result as Long
myPos.row = 18
myPos.column = 45
myLength = 400
result = screen.GetStringWithAttribs(myPos, myString, myLength)

 


Back to IScreen members


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