Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Gets

Searches the

text of the IField at

field at the specified position for the specified

ScreenPosition

text.

Namespace:  JollyGiant.Emulation
Assembly:  JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Image AddedSyntax

C#
public StatusCode 
GetText
Search(
	ref ScreenPosition position,
	
ref fieldText, int toCopy
searchText
)


Visual Basic (Declaration)
Public Function 
GetText
Search ( _
	ByRef position As ScreenPosition, _
	
ByRef
searchText 
fieldText , _ toCopy As Integer
 _
) As StatusCode


Visual C++
public:
virtual StatusCode 
GetText
Search(
	ScreenPosition% position, 
	String
^% fieldText, int toCopy
^ searchText
) sealed


JavaScript
function 
GetText
Search(position, 
fieldText, toCopy
searchText);

Parameters

position
Type: JollyGiant.Emulation..ScreenPosition
Position of the

IField for which to retrieve

field to search for the text.

fieldText

searchText
Type: System..

::. %Buffer for the field text.toCopy Type: System..::.Int32Maximum number of characters to copy


Text to search for.

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 successfullyWHLLTRUNCATEDThe specified field text was retrieved, but the IField was of greater length than the number specified in toCopy, and the text is truncated
search string was found.
WHLLNOTCONNECTEDYour application is not currently connected to a host session.
WHLLPARAMETERERROR
One or more call parameters are invalid.
String was length zero or greater than the session presentation space size.
WHLLPOSITIONERRORThe specified presentation space position
is
was invalid.
WHLLSYSERRORThe method failed due to a system error.
WHLLNOFIELDThe search string was not found, or the session presentation space is unformatted.


Implements

IField..
::.GetText%, Int32
)

Image AddedSee Also


Field Class
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.