Name

Description

HRESULT
WaitForToolsInGuest([in] LONG timeoutInSeconds,
                    [in] ICallback* jobDoneCallback,
                    [out,retval] IJob** waitJob);

This function signals the IJob object when VMware Tools has successfully started in the guest operating system. VMware Tools is a collection of services that run in the guest.

Parameters

timeoutInSeconds

The timeout in seconds. If VMware Tools has not started by this time, the function completes with an error. If the value of this argument is zero or negative, then there will be no timeout.

jobDoneCallback

An ICallback instance that will be called when the operation is complete.

waitJob

Returns an IJob object that describes the state of this asynchronous operation.

Return Value

Remarks

• This function 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, this function reports an error to the job object.
• The VIX_PROPERTY_VM_TOOLS_STATE property of the virtual machine handle is undefined until VM::WaitForToolsInGuest() reports that VMware Tools is running.

Side Effects

Requirements

Example

Dim lib
Dim job
Dim err
Dim results
Dim host
Dim vm

Set lib = CreateObject("VixCOM.VixLib")

Set results = Nothing

Set job = lib.Connect(VixCOM.Constants.VIX_API_VERSION, VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_WORKSTATION, Empty, 0, Empty, Empty, 0, Nothing, Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   WScript.Echo("Error: " & lib.GetErrorText(err, empty))
   WScript.Quit
End If


Set host = results(0)

Set job = host.OpenVM("c:\Virtual Machines\vm1\win2000.vmx", Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   WScript.Echo("Error: " & lib.GetErrorText(err, empty))
   WScript.Quit
End If

Set vm = results(0)

Set job = vm.PowerOn(VixCOM.Constants.VIX_VMPOWEROP_LAUNCH_GUI, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   WScript.Echo("Error: " & lib.GetErrorText(err, empty))
   WScript.Quit
End If

Set job = vm.WaitForToolsInGuest(0, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   WScript.Echo("Error: " & lib.GetErrorText(err, empty))
   WScript.Quit
End If

host.Disconnect()