![](https://pdfstore-manualsonline.prod.a.ki/pdfasset/8/4b/84b83c2a-f328-4c4a-bfa7-955024e21d40/84b83c2a-f328-4c4a-bfa7-955024e21d40-bg4b.png)
CHAPTER 4 Operations on Virtual Machines
75
RC1
VixVM_WaitForToolsInGuest
Function Signature
VixHandle
VixVM_WaitForToolsInGuest(VixHandle vmHandle,
int timeoutInSeconds,
VixEventProc *callbackProc,
void *clientData);
Parameters
Results
VixHandle — A job handle that describes the state of this asynchronous operation.
Notes
• This function will signal the job when VMware Tools has successfully started in
the guest operating system. VMware Tools is a collection of services that run in
the guest.
• VMware Tools must be installed and running for some VIX functions to operate
correctly. If VMware Tools is not installed in the guest operating system, or if the
virtual machine is not powered on, then this function reports an error to the job
object.
• The FOUNDRY_VM_TOOLS_STATE_PROPERTY of the virtual machine
handle is undefined until
VixVM_WaitForToolsInGuest() reports that
VMware Tools is running.
vmHandle Identifies a virtual machine. Call VixVM_Open() to create a virtual
machine handle.
timeoutInSeconds The timeout in seconds. If the VMware Tools has not started by this
time, then the function completes with an error.
callbackProc A callback function that will be invoked when the power operation is
complete.
clientData A parameter that will be passed to the callbackProc function.