Name

BeginReplay

Description

HRESULT
BeginReplay(ISnapshot* recording,
            LONG options,
            IVixHandle* propertyList,
            ICallback* jobDoneCallback,
            IJob** pauseJob);

This function replays a recording of a virtual machine.

Parameters

recording: snapshot object that represents the recording.
options: Must be VIX_VMPOWEROP_NORMAL or VIX_VMPOWEROP_LAUNCH_GUI.
propertyListHandle: Must be NULL (C++), null (C#), or Nothing (VB).
jobDoneCallback: An ICallback instance that will be called when the operation is complete.
replayJob: Returns an IJob object that describes the state of this asynchronous operation.

Return Value

HRESULT

Remarks

This function only works on a virtual machine that is not already recording or replaying.
Use of this function with a non-recording snapshot returns VIX_E_INVALID_ARG.
To display playback of the recording with the Workstation user interface, powerOnOptions must have the VIX_VMPOWEROP_LAUNCH_GUI flag. If there is an existing instance of the Workstation user interface, the virtual machine will power on in a new tab within that instance. Otherwise, a new instance of Workstation will open, and the virtual machine will power on there.
Guest commands are not allowed while the virtual machine is replaying a recording.
Once the recording has finished, the virtual machine will automatically "go live"; it will resume normal execution from the last state that is part of the recording.
The property VIX_PROPERTY_SNAPSHOT_IS_REPLAYABLE can be used to determine if a snapshot is a recording.

Side Effects

None.

Requirements

VixCOM.h, since VMware Workstation 6.5

Example

The following example shows how to record the execution of a virtual machine while a program is running, then stop the recording once the program exits, and then replay that recording.

VBScript:

' Start the recording
Set job = vm.BeginRecording("Recording of testApp", "Testing a new feature", _
                            0, Nothing, Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

recording = results(0)

' Run the program
Set job = vm.RunProgramInGuest("C:\testApp.exe", "", 0, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

' By default, RunProgramInGuest waits until the program has finished running.

' Stop the recording.
Set job = vm.EndRecording(0, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

' Power off the virtual machine before replaying the recording.
Set job = vm.PowerOff(0, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set job = vm.BeginReplay(recording, 0, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If