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

ctrx_wait_for_event

Example: ctrx_wait_for_event Synchronization Functions

Waits for a specified event to occur.

int ctrx_wait_for_event( char *event, [CONTINUE_ON_ERROR,] CTRX_LAST );
event

The name of the event to wait for. One of:

  • LOGON_AND_AGENT
  • LOGON
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_wait_for_event is a synchronization function that waits for an event to occur.

Session initialization and CitrixAgent initialization may take longer than LOGON. As a result, ctrx* functions that follow immediately after ctrx_wait_for_event(LOGON) may fail. To ensure that the agent is running before continuing to the next step, use ctrx_wait_for_event(LOGON_AND_AGENT).

Return Values

Citrix ICA Return Values

Parameterization

Standard parameterization is not available for this function.