Citrix Script Functions

CitrixWaitForWindowCreation, used for screen synchronization, is the most important Citrix function.

The first parameter that synchronizations consider is window caption. If during replay a window caption is returned that matches the caption of the window that was recorded during replay, then the verification succeeds.

Note: Wildcards (*) can be specified at the end or beginning of window captions.

The second parameter considered is the match parameter. Normally this is an exact, case-sensitive comparison of window caption strings.

The third parameter is the style of the window. If a window caption name is not available, then a portion of the style name is used to identify the window. Styles reflect whether or not windows were maximized during recording.

The fourth parameter considered is the position of the window. This may be a negative number, as maximized windows have a position of -4, -4. This parameter can be controlled via the Force window position profile setting. When this profile setting is enabled, windows are automatically moved to the exact positions they held during recording.

The fifth parameter is window size. During replay windows must be resized to the same size they had during recording.

CitrixWaitForLogon waits until a Citrix client logs on successfully or a specified timeout period expires.

CitrixWaitForScreen captures screen regions and checks them against specified conditions (normally a hash value captured at recording). If a condition does not match and the timeout period expires, the function call fails. CitrixWaitForScreen functions also use screen appearance to synchronize subsequent user actions. Based on provided parameters, this function waits until the image in a specified screen region changes, matches the hash value captured at recording, or does not match the hash value captured at recording.

CitrixGetScreen takes a screenshot of a selected region and writes the screenshot to a file in the result directory. If the file name is omitted, it will be automatically generated by the user ID and hash value of the image.

CitrixGetScreenHash retrieves the hash value of a selected screen.

CitrixSetOption sets particular options, such as network protocol specification, speed screen latency reduction, data compression, image caching, mouse/keyboard timings and event queueing, client disconnect, synchronization time-outs, think times, TrueLog capture, and window position forcing.

CitrixWaitForWindow waits until a specified window event (specified with the nEvent parameter) occurs. Such events may be an activation, destruction or caption change for a specified window. If the selected event is a caption change, a matching caption change for the specified window will satisfy the function. Captions can be specified explicitly using the sCaption and nMatch parameters.

CitrixKeyString is the standard function for entering printable characters.

CitrixMouseClick moves the mouse to a specified position and presses a specified button. Optionally, the mouse can be specified to move while the button is pressed. Key modifiers (such as Ctrl and Alt) can be used.