GetString (Method)

IScreen::GetString

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

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

Parameters

No	Name	Type	Optional	Default	Description
1	cursor	CursorPos	No	-	Position in the screen where copy is to begin
2	buffer	String	No	-	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 * 200
Dim myPos as CursorPos
Dim myLength as Long
Dim result as Long
myLength = 200
myPos.row = 18
myPos.column = 45
result = screen.GetString(myPos, myString, myLength)