Share this page

# Alphabetical Listing of Citrix Functions

Click one of the following functions for more information:

ctrx_activate_window | Activates a window.
ctrx_activate_window_by_id | Activates the window specified by a given ID.
ctrx_button_get_info | Retrieves information about a push button.
ctrx_connect_server | Logs in to a Citrix server. Note: Supported only for legacy single-protocol Citrix scripts.
ctrx_disconnect_server | Disconnects a Citrix client from a Citrix server. Note: Supported only for legacy single-protocol Citrix scripts.
ctrx_edit_get_info | Retrieves information about a text edit field.
ctrx_execute_on_window | Specifies handler function on window appearance.
ctrx_execute_on_window_activation | Specifies handler function on window activation.
ctrx_execute_on_window_destroy | Specifies handler function when a window is closed (destroyed).
ctrx_execute_on_window_name_change | Specifies handler function when a window's name changes.
ctrx_find_window_by_name | Searches all tracked windows for a specified window.
ctrx_get_bitmap_value | Returns the value of a bitmap as a string
ctrx_get_server_name | Retrieves the name of the active server the client is connected to. Note: Supported only for legacy single-protocol Citrix scripts.
ctrx_get_text | Retrieves the text in a rectangle.
ctrx_get_text_ocr | Retrieves the text in a rectangle using Optical Character Recognition.
ctrx_get_text_location | Searches for a text in a selected area and retrieves the text location.
ctrx_get_waiting_time | Gets current wait time.
ctrx_get_window_id_by_order | Retrieves the ID of the window in the specified position in the window stack.
ctrx_get_window_name | Retrieves the name of the active window.
ctrx_get_window_name_by_id | Retrieves the name of the specified window.
ctrx_get_window_parent_id | Retrieves the ID of the parent window of a specified window.
ctrx_get_window_pos_by_id | Retrieves the position of a window specified by a given ID.
ctrx_get_window_position | Retrieves the position of a window.
ctrx_get_window_size_by_id | Retrieves the size of a window.
ctrx_get_window_style_by_id | Retrieves the style and extended style of a window.
ctrx_key | Emulates a non-alphanumeric key press on a Citrix client
ctrx_list_get_info | Retrieves information about a list box.
ctrx_list_select_item | Selects an item from a list.
ctrx_logoff | Closes the current session.
ctrx_menu_select_item | Highlights a menu item.
ctrx_mouse_click | Emulates a mouse click on a Citrix client
ctrx_mouse_double_click | Emulates a double mouse click on a Citrix client
ctrx_mouse_down | Emulates a mouse down click on a Citrix client
ctrx_mouse_move | Emulates a mouse move on a Citrix client sent to a Citrix server.
ctrx_mouse_up | Emulates a mouse up click on a Citrix client
ctrx_<obj>_get_info | Retrieves information about an object.
ctrx_mouse_click | Emulates a mouse click on a Citrix client
ctrx_mouse_double_click | Emulates a double mouse click on a Citrix client
ctrx_mouse_down | Emulates a mouse down click on a Citrix client
ctrx_mouse_up | Emulates a mouse up click on a Citrix client
ctrx_nfuse_connect | Connects to a Citrix server via an NFUSE portal
ctrx_run_published_app | Invokes a published application. Note: Supported only for legacy single-protocol Citrix scripts.
ctrx_save_bitmap | Saves the demarcated bitmap in a buffer.
ctrx_set_connect_opt | Sets a connection option to a Citrix ICA server and logs in to a Citrix server. Note: Supported only for legacy single-protocol Citrix scripts.
ctrx_set_exception | Deprecated. Use ctrx_execute_on_window.
ctrx_set_waiting_time | Sets the waiting time for all Citrix ICA wait functions
ctrx_set_window | Waits for a window to appear in the Citrix client
ctrx_set_window_ex | Waits for a window to appear in the Citrix client for a specified amount of time
ctrx_sync_on_bitmap | Waits until a bitmap appears
ctrx_sync_on_bitmap_change | Waits until a bitmap changes
ctrx_sync_on_obj_info | Wait until the specified object's attributes have the specified value
ctrx_sync_on_text | Waits until specified text is displayed around the specified position.
ctrx_sync_on_text_ex | Waits until specified text is displayed in the specified area.
ctrx_sync_on_text_ocr | Waits until specified text is displayed in the specified rectangle, using optical character recognition.
ctrx_sync_on_window | Waits for a window to become created or active
ctrx_type | Emulates alphanumeric key presses on a Citrix client
ctrx_unset_window | Waits for a window to close in the Citrix client
ctrx_wait_for_event | Waits for a specified event to occur
ctrx_win_exist | Checks if a window is visible on the screen
ctrx_window_move_by_id | Moves the specified window.
ctrx_window_resize_by_id | Resizes the specified window.

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