Edit C:\Program Files (x86)\VMware\VMware VIX\doc\lang\perl\functions\VMGetRootSnapshot.html

<html>
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<meta HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<link rel="stylesheet" href="../../../foundrydoc.css" type="text/css" charset="ISO-8859-1">
<link rel="stylesheet" href="foundrydoc.css" type="text/css" charset="ISO-8859-1">
</head>
<body>
<h1>Name</h1>
<b>VMGetRootSnapshot</b>
<h1>Description</h1>
<pre>
($err, $snapshotHandle) = VMGetRootSnapshot($vmHandle,
                                            $index);
</pre>
<p>
This function returns the handle of the specified snapshot belonging to
the virtual machine referenced by
vmHandle.
<dt><i>vmHandle</i></dt>
<dd>
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
</dd>
<dt><i>index</i></dt>
<dd>
Identifies a root snapshot. See below for range of values.
</dd>
</dl>
<h1>Return Value</h1>
$err.  The error code returned by the operation. For returned values, see Topics &gt; Error Codes.
<p>
$snapshotHandle.  A handle to the snapshot.
<h1>Remarks</h1>
<ul>
<li> This function returns the handle of the specified snapshot belonging to
the virtual machine referenced by vmHandle.
<li> Snapshots are indexed from 0 to n-1, where n is the number of root
snapshots. Use the function 
VMGetNumRootSnapshots()
to get the
value of n.
<li> VMware Server can manage only a single snapshot
for each virtual machine. The value of index can only be 0.
<li> The snapshotHandle returned by this function is reference counted.
The calling application is responsible for releasing the handle.
<li> This function is not supported when using the 
VIX_SERVICEPROVIDER_VMWARE_PLAYER
host type.
</ul>
<h1>Side Effects</h1>
None.
<h1>Requirements</h1>
<pre>
use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
[encode]
since VMware Server 1.0

[example]
<pre>
my $err = VIX_OK;
my $hostHandle = VIX_INVALID_HANDLE;
my $vmHandle = VIX_INVALID_HANDLE;
my $snapshotHandle = VIX_INVALID_HANDLE;
my $numRootSnapshots;
my $i;

($err, $hostHandle) = HostConnect(VIX_API_VERSION,
                                  VIX_SERVICEPROVIDER_VMWARE_WORKSTATION,
                                  undef, # hostName
                                  0, # hostPort
                                  undef, # userName
                                  undef, # password
                                  0, # options
                                  VIX_INVALID_HANDLE); # propertyListHandle

die "HostConnect() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

($err, $vmHandle) = VMOpen($hostHandle,
                           "c:\\Virtual Machines\\vm1\\win2000.vmx");
die "VMOpen() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

($err, $numRootSnapshots) = VMGetNumRootSnapshots($vmHandle);
die "VMGetNumRootSnapshots() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

for ($i = 0; $i &lt; $numRootSnapshots; $i++) {
   ($err, $snapshotHandle) = VMGetRootSnapshot($vmHandle,
                                               $i); # index
   die "VMGetRootSnapshot() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

# ...Access snapshot properties...

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de