Searches the presentation space for a specified string.
Namespace: JollyGiant.Emulation
Assembly: JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# |
|---|
public StatusCode Search( ref int row, ref int column, string searchText ) |
| Visual Basic (Declaration) |
|---|
Public Function Search ( _ ByRef row As Integer, _ ByRef column As Integer, _ searchText As String _ ) As StatusCode |
| Visual C++ |
|---|
public: virtual StatusCode Search( int% row, int% column, String^ searchText ) sealed |
| JavaScript |
|---|
function Search(row, column, searchText); |
Parameters
row
Type: System..::.Int32 %If Int32
If the string is found, will contain the row where string is found.
column
Type: System..::.Int32 %If Int32
If the string is found, will contain the column where string is found.
searchText
Type: System..::.StringThe String
The string to search for.
Return Value
The StatusCode indicating the result of the operation.
This can be one of the following values:
| Status code | Description |
|---|---|
| Ok | The method completed successfully. You must check the position value to determine if the string was found. |
| WHLLNOTCONNECTED | Your application is not currently connected to a session (see Connect(Object)). |
| WHLLPARAMETERERROR | Invalid parameters were specified. |
| WHLLPOSITIONERROR | Specified screen position value is invalid. |
| WHLLSYSERROR | The method failed due to a system error. |
| WHLLNOFIELD | The string was not found. |
Implements
IScreen..::.Search(Int32%, Int32%, String)
Remarks
A position on the screen that appears blank may contain a space or a null byte. If the search string contains spaces, and the screen contains null bytes in those positions, the string will not be found, even though it may be visible on the screen.
See Also
Screen Class
JollyGiant.Emulation Namespace
ISession..::.Connect(Object)
Send comments on this topic to Jolly Giant Software
...