($err, $snapshotHandle) = VMBeginRecording($vmHandle, $name, $description,
This function records a virtual machine's activity as a snapshot object.
Identifies a virtual machine. Call VMOpen()
to create a virtual machine handle.
A user-defined name for the recording; need not be unique.
A user-defined description for the recording.
Must be zero.
Must be VIX_INVALID_HANDLE.
$err. The error code returned by the operation. For returned values, see Topics > Error Codes.
$snapshotHandle. The handle to the snapshot object.
- Record-replay functionality has been deprecated and this function may be removed from future versions of the VIX API.
- The virtual machine must be powered on. To record the virtual machine
from the beginning, call VixVM_PowerOn with VIX_VMPOWEROP_START_VM_PAUSED,
then start recording.
- This function only works on a virtual machine that is not already
recording or replaying.
- If recording name is NULL, creates a snapshot object with no name.
- This function is not supported when using the
- This function disrupts communication with VMware Tools.
Any outstanding Vix related guest operation may be aborted. Users will
need to call
before performing additional operations in the guest.
since VMware Workstation 6.5
($err, $snapshotHandle) = VMBeginRecording($vmHandle, "recording 2",
"description of recording 2",
die "VMBeginRecording() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;
# wait for some activity to happen, then stop recording
$err = VMEndRecording($vmHandle, 0, VIX_INVALID_HANDLE);
die "VMEndRecording() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;