Name
GetNumRootSnapshots
Description
HRESULT
GetNumRootSnapshots([out] LONG* result,
[out,retval] ULONGLONG* error);
This function returns the number of top-level (root) snapshots belonging
to a virtual machine.
Parameters
- result
-
(output) The number of root snapshots on this virtual machine.
Return Value
HRESULT
Remarks
- This function returns the number of top-level (root) snapshots
belonging to a virtual machine. A top-level snapshot is one that is
not based on any previous snapshot. If the virtual machine has more than one
snapshot, the snapshots can be a sequence in which each snapshot is
based on the previous one, leaving only a single top-level snapshot.
However, if applications create branched trees of snapshots, a single
virtual machine can have several top-level snapshots.
- VMware Server can manage only a single snapshot
for each virtual machine. All other snapshots in a sequence are
ignored. The value of the result parameter is always 0 or 1.
Side Effects
None.
Requirements
VixCOM.h, since VMware Workstation 6.0