Name

SnapshotGetChild

Description

($err, $childSnapshotHandle) = SnapshotGetChild($parentSnapshotHandle,
                                                $index);

This function returns the specified child snapshot.

Parameters

parentSnapshotHandle: A snapshot handle.
index: Index into the list of snapshots.

Return Value

$err. The error code returned by the operation. For returned values, see Topics > Error Codes.

$childSnapshotHandle. A handle to the child snapshot.

Remarks

Snapshots are indexed from 0 to n-1, where n is the number of child snapshots. Use the function SnapshotGetNumChildren() to get the value of n.

Side Effects

None.

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;

since VMware Workstation 6.0

Example

my $parentSnapshot;
my $childSnapshot;
my $numChildren;
my $err;
my $i;

($err, $numChildren) = SnapshotGetNumChildren($parentSnapshotHandle);
printf "the snapshot has %d child snapshots\n", $numChildren;
for ($i = 0; $i < $numChildren; $i++) {
    ($err, $childSnapshot) = SnapshotGetChild($parentSnapshotHandle, $i);
}