Field.GetText Method
Gets the text of the IField at the specified ScreenPosition.
Namespace: Â JollyGiant.Emulation
Assembly: Â JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C# |
---|
public StatusCode GetText( ScreenPosition position, ref string fieldText, int toCopy ) |
Visual Basic (Declaration) |
---|
Public Function GetText ( _ position As ScreenPosition, _ ByRef fieldText As String, _ toCopy As Integer _ ) As StatusCode |
Visual C++ |
---|
public: virtual StatusCode GetText( ScreenPosition position, String^% fieldText, int toCopy ) sealed |
JavaScript |
---|
function GetText(position, fieldText, toCopy); |
Parameters
position Type: JollyGiant.Emulation..::.ScreenPosition  Position of the IField for which to retrieve the text.
fieldText Type: System..::.String  Buffer for the field text.
toCopy Type: System..::.Int32Â Â Maximum number of characters to copy.
Return Value
The StatusCode indicating the result of the operation.This can be one of the following values:
Status code | Description |
---|---|
WHLLOK | The specified IField field was copied successfully. |
WHLLNOTCONNECTED | Your application is not currently connected to a host session. |
WHLLPARAMETERERROR | One or more call parameters are invalid. |
WHLLTRUNCATED | The specified field text was retrieved, but the IField was of greater length than the number specified in toCopy, and the text is truncated. |
WHLLPOSITIONERROR | The specified presentation space position is invalid. |
WHLLSYSERROR | The method failed due to a system error. |
WHLLNOFIELD | The presentation space is unformatted. |