CitrixPing Function

Action

Sends a ping synchronization request to the currently connected Citrix server, with sPingData as payload. This function waits until either the server responds or the timeout expires.

Include file

CitrixAPI.bdh

Syntax

CitrixPing( in  sPingData : string,
            out nRTT      : number,
            in  nTimeout  : number optional ): boolean;

Return value

true if the function succeeds
false otherwise

Parameter	Description
sPingData	Payload sent to the server.
nRTT	Retrieves the round-trip time of the sent ping request.
nTimeout	Specifies the time to wait for the server to respond (optional). When this parameter is omitted or set to `0`, the default timeout is used. The default value can be adjusted by profile settings ( Settings > Active Profile > Citrix > General > Synchronization timeout ) or an appropriate call to the `CitrixSetOption` function.

Example:

  transaction TMain
  var
    nRTT : number;
  begin
    CitrixInit(640, 480);
    CitrixSetApplication("Excel");
    CitrixConnect("myserver", "myusername", "mypass", "mydomain", COLOR_16bit);
    CitrixWaitForLogon();
    hWnd4 := CitrixWaitForWindowCreation("Microsoft Excel - Book*", MATCH_Wildcard, 0x15CF0000, -4, -4, 648, 488);
    CitrixKeyString("test");
    CitrixMouseClick(636, 14, hWnd4, MOUSE_ButtonLeft);
    ThinkTime(2.63);
    CitrixMouseClick(306, 289, hWnd4, MOUSE_ButtonLeft);
    CitrixWaitForWindow(hWnd4, EVENT_Destroy);
    CitrixPing("payload", nRTT);
    print("CitrixPing round trip time: " + string(nRTT));
    CitrixDisconnect();
  end TMain;