Get Text (Method)

IField::GetText

Retrieve the contents of the specified field.

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

Parameters

No	Name	Type	Optional	Default	Description
1	cursor	CursorPos	No	-	Position inside the field for which you want to retrieve the data
2	buffer	String	No	-	Buffer to hold the copied data on output. The buffer must be at least as long as the data field to be copied.
3	bufsize	Long	No	-	Size of the output buffer
Return Code			Description
JGS_OK			The specified field was copied successfully
JGS_PARAMETERERROR			Missing or invalid parameter
JGS_MEMORY			Not enough memory to complete the operation
JGS_NOTCONNECTED			Your application is not connected to a valid session
JGS_TRUNCATED			The field contents were copied successfully but the field was longer than the buffer size and the data was truncated
JGS_POSITIONERROR			The screen position was invalid
JGS_SYSERROR			The function failed due to a system error
JGS_NOFIELD			The screen is not formatted

Sample Code

Dim myPos as CursorPos
Dim myBuffer as String * 200
Dim myLength as Long
Dim result as Long
myLength = 200
myPos.row = 18
myPos.column = 45
result = field.GetText(myPos, myBuffer, myLength)

Back to IField members