pcoip_sync_on_text
Example | Teradici PCoIP Protocol Functions |
Waits until specified text is displayed at the specified location.
Note: The text is identified using optical character recognition (OCR).
Known issue: The OCR engine removes the spaces from the recognized text.
int pcoip_sync_on_text( long x, long y, long width, long height, char value, char snapshot, long timeout, char* waitFor, char* LAST);
x | The horizontal distance, in pixels, of the bitmap's top left edge from the left border of the client window. |
y | The vertical distance, in pixels, of the bitmap's top left edge from the upper border of the client window. |
width | The width, in pixels, of the bitmap containing the relevant text. |
height | The height, in pixels, of the bitmap containing the relevant text. |
value | The text for which to wait. |
snapshot | The snapshot name. |
timeout | The amount of time, in seconds, to wait until the expected text matches the actual text. Default: 60 seconds (can be edited manually) |
WaitFor | The event to occur on one of the specified areas and images. This argument is optional. The function’s behavior with the WaitFor events is as follows:
The default is Appear. |
LAST | Marker that indicates the end of the argument list. |
Parameterization
Standard parameterization is not available for this function.
Example
In this example, pcoip_sync_on_text causes the script to pause for the amount of time specified (timeout = 15 seconds), while searching for the text "Jungle" at the specified coordinates.
pcoip_sync_on_text(6, 47, 90, 44, "Jungle", "snapshot4", 15, "WaitFor=Appear", LAST);