Set_Text_(Function)
Copy the text to the start of the specified field.
Function SetText(cursor As CursorPos, text As String) As Long
Parameters
No | Name | Type | Optional | Default | Description |
---|---|---|---|---|---|
1 | cursor | CursorPos | No | - | Any position inside the field to copy the text to. The copy will always begin at the start of the field. Any position inside the field will provide the same result. |
2 | text | String | No | - | Text to copy to the field. Must be a null terminated string. |
Return Code | Description | ||||
JGS_OK | The text was copied successfully | ||||
JGS_NOTCONNECTED | Your application is not currently connected to a valid session | ||||
JGS_PARAMETERERROR | Missing or invalid parameter | ||||
JGS_INHIBITED | Field is protected or the data is invalid (such as alphabetic text into numeric field, or trying to copy field attribute byte) | ||||
JGS_TRUNCATED | The string was copied successfully, but one or more characters were truncated | ||||
JGS_POSITIONERROR | The screen position you specified was invalid | ||||
JGS_SYSERROR | The function failed due to a system error | ||||
JGS_NOFIELD | The screen is not formatted (no fields exist) |
Sample Code
Dim myPos as CursorPos
Dim myText as String
Dim result as Long
myPos.row = 18
myPos.column = 45
myText = "Jolly Giant Software"
result = field.SetText(myPos, myText)
QWS3270 Automation copyright © Jolly Giant Software Inc. All rights reserved.