Share this page

# rdp_sync_on_text

Pauses script execution until a specified string appears in the specified area before resuming.

Synchronization Functions

int rdp_sync_on_text( "StepDescription=<step description>", "Snapshot=<snapshot>", ["ConnectionID=<connection_identifier>",] ["WindowTitle[/RE]=<window_title>",] ["WindowOrdinal=<window_ordinal>",] "TextX=<x_position>", "TextY=<y_position>", "Text=<text>", ["Timeout=<timeout>",] ["FailStepIfNotFound=<Default | Yes | No>",] RDP_LAST );

This function returns one of the following:

LR_PASS (0): The function completed without error.

LR_FAIL (1): The function completed with errors.

LR_NOT_FOUND (2): The function's FailStepIfNotFound argument is set to No and the object does not have the specified attribute before timing out.

LR_PASS does not indicate that the test step passed-only that the function ran to completion. For example, LR_PASS does not indicate that the server returned the expected value.

All string arguments (char type) can be parameterized using standard parameterization.

Argument | Description
--- | ---
StepDescription | A descriptive, unique name for this step. Use any text.
Snapshot | The name of the snapshot file of the screen state before this step.
ConnectionID | The name of the connection on which this function operates. Do not change the recorded ID. If several connections are open and the ID is not specified, the first connection in the script is used. If only one connection is open, the connection ID is unnecessary.
"WindowTitle=" "WindowTitle/RE=" | The title of the window. The value for Title is a literal string, for example, `"Title=Quality Center"`. If you use WindowTitle/RE, the value is a regular expression, for example, `"WindowTitle/RE=^Document[0-9]+ - Microsoft Word"`.
WindowOrdinal | The 1-based index of the window among the session windows that match the title specified by WindowTitle or WindowTitle/RE. For example, if the WindowTitle/RE and WindowOrdinal arguments are `"WindowTitle/RE=Document[0-9]+ - Microsoft Word"` and `"WindowOrdinal=3"`, the window specified is the third window in the creation order of the existing windows whose title matches the regular expression `"Document[0-9]+ - Microsoft Word"`. If this optional argument is omitted, the default value is 1.
TextX | The horizontal distance in pixels from the left border of the specified window.
TextY | The vertical distance of the object from the top edge of the window.
Text | The text for which to wait.
Timeout | The wait time in seconds. If the timeout is exceeded, the function returns LR_FAIL. If no timeout is passed, the default value is taken from the runtime settings.
FailStepIfNotFound | Possible values: Yes, No, or Default. If the window is not found and this argument is set to No, the function returns LR_NOT_FOUND (2).
RDP_LAST | The delimiter marking the end of the argument list.

The rdp_sync_on_text function is a synchronization function that suspends the script run until text appears at specified coordinates in a window.

This function requires that an RDP agent be installed on the RDP Server.

## Example

The following shows a script waiting for the text `Hello World` to appear in a Notepad window.

rdp_sync_on_text(
"StepDescription=Sync on Text 1",
"Snapshot=snapshot1.inf",
"WindowTitle=Notepad",
"TextX=263",
"TextY=258",
"Text=Hello World",
RDP_LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: