Name

PumpEvents

Description

HRESULT
PumpEvents([in] LONG options)

PumpEvents is used in single threaded applications that require the Vix library to be single threaded. Tasks that would normally be executed in a separate thread by the Vix library will be executed when PumpEvents() is called.

Parameters

Return Value

None.

Remarks

This option is designed for client applications that want to receive events on only one thread, such as a thread that manages the user interface. In this case, open the local host handle with the VixCOM.Constants.VIX_HOSTOPTION_USE_EVENT_PUMP option, and call PumpEvents() in the main event loop. If you fail to call PumpEvents(), Vix asynchronous actions will not execute.
If you do not open your local host with the VixCOM.Constants.VIX_HOSTOPTION_USE_EVENT_PUMP option, calling PumpEvents(), has no effect. If you do not open your local host with the VixCOM.Constants.VIX_HOSTOPTION_USE_EVENT_PUMP option, the VIX API creates a small pool of threads for executing asynchronous operations. Events can be posted from those worker threads, so your code must be thread-safe.

Side Effects

None.

Requirements

VixCOM.h, since VMware Workstation 6.0.