Translate page

IField_GetText Method

Owned by Julio Rios (Unlicensed)
Last updated: May 16, 2017
1 min read

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#
StatusCode GetText(
	ScreenPosition position,
	ref string fieldText,
	int toCopy
)
Visual Basic (Declaration)
Function GetText ( _
	position As ScreenPosition, _
	ByRef fieldText As String, _
	toCopy As Integer _
) As StatusCode
Visual C++
StatusCode GetText(
	ScreenPosition position, 
	String^% fieldText, 
	int toCopy
)
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 codeDescription
WHLLOKThe specified IField field was copied successfully.
WHLLNOTCONNECTEDYour application is not currently connected to a host session.
WHLLPARAMETERERROROne or more call parameters are invalid.
WHLLTRUNCATEDThe specified field text was retrieved, but the IField was of greater length than the number specified in toCopy, and the text is truncated.
WHLLPOSITIONERRORThe specified presentation space position is invalid.
WHLLSYSERRORThe method failed due to a system error.
WHLLNOFIELDThe presentation space is unformatted.


See Also


IField Interface
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.