Share this page

# ctrx_sync_on_obj_info

Example | Citrix Synchronization Functions

Wait until the specified object's attributes have the specified value.

`int ctrx_sync_on_obj_info( char *window_name, long xpos, long ypos,eObjAttribute attribute, char *value, [CONTINUE_ON_ERROR,] CTRX_LAST );`

window_name | The window title.
xpos | The horizontal distance, in pixels, from the left border of the specified window.
ypos | The vertical distance, in pixels, from the upper border of the specified window.
attribute | One of the Object Attributes constants.
value | The value of the attribute.
CONTINUE_ON_ERROR | A constant, entered as shown without quotes. Overrides the error behavior runtime setting for this step so that script behaves as though the runtime setting was Continue on error.
CTRX_LAST | A marker that indicates the end of the argument list.

Note: This function is available only if the Citrix agent is installed. For details, see Citrix agent overview in the VuGen Help Center (select the relevant version).

When ctrx_sync_on_obj_info is called, execution pauses until the attribute of the specified object has the specified value.

The attribute argument is an enumerated type, not a string. It is passed without quote marks.

The asterisk wildcard character (*) can be used in window_name.

## Return Values

Citrix ICA Return Values

## Parameterization

No parameterization is available for this function.

## Example

This example causes execution to pause until the window has focus.

`ctrx_sync_on_obj_info("-2_572_805_31", 75, 6, FOCUSED, "TRUE", CTRX_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: