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

ctrx_sync_on_bitmap

Example: ctrx_sync_on_bitmap Synchronization Functions

Waits until a bitmap appears.

int ctrx_sync_on_bitmap( long x_start, long y_start,long width, long height, char *hash, [CONTINUE_ON_ERROR,] CTRX_LAST );
x_start The horizontal distance, in pixels, of the bitmap's top left edge from the left border of the ICA client window
y_start The vertical distance, in pixels, of the bitmap's top left edge from the upper border of the ICA client window
width The width, in pixels, of the bitmap
height The height, in pixels, of the bitmap
hash An encoded string representing the bitmap
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_bitmap is a synchronization function that waits for a specified bitmap to appear before continuing.

This function is typically used when a change occurs in a window but the window name remains the same. If the window name changes, ctrx_set_window is recorded instead of ctrx_sync_on_bitmap.

The function can be manually recorded by clicking on the rectangle icon in VuGen's Citrix recording toolbar. The mouse pointer changes to a precision shape, which you use to select a bitmap area.

Return Values

Citrix ICA Return Values

Parameterization

No parameterization is available for this function.