Citrix ICA Vuser Functions (CTRX) > Alphabetical List of Functions > ctrx_sync_on_text_ex


Example: ctrx_sync_on_text_ex Synchronization Functions

Waits until specified text is displayed in the specified area.

int ctrx_sync_on_text_ex( long xpos, long ypos, long width, long height, const char *value, const char *window_name, [CONTINUE_ON_ERROR,] CTRX_LAST );
xpos The horizontal distance in pixels of the search rectangle from the left border of the ICA client window.
ypos The vertical distance in pixels of the search rectangle from the upper border of the ICA client window.
width The width of the search rectangle in pixels.
height The height of the search rectangle in pixels.
value The text to for which to wait.
window_name The window title. The asterisk wildcard character (*) can be used in window_name.
CONTINUE_ON_ERROR A constant, entered as shown without quotes. Overrides the error behavior run-time setting for this step so that script behaves as though the run-time setting was Continue on error.
CTRX_LAST A marker that indicates the end of the argument list.

ctrx_sync_on_text_ex is a synchronization function that waits for a specified string to appear in the specified area before continuing.

When ctrx_sync_on_text_ex is recorded, the textEvent argument is set by the logic of the recording engine. Do not edit it.

ctrx_sync_on_text_ex can be inserted in a script during recording or after recording from the script tree view.

If you wish to enter the function manually, run the script once using ctrx_get_text to find the exact string. Then, comment out the ctrx_get_text call and enter the string as the value argument in the ctrx_sync_on_text_ex call.

ctrx_sync_on_text_ex function is recorded automatically before each mouse click and double click.

Note: Under Windows XP, to correctly record menu entries during recording, give the window focus before clicking on the menu item.

This function is available only if the agent is installed on the Citrix server.

Return Values

Citrix ICA Return Values


No parameterization is available for this function.