Name

SnapshotGetNumChildren

Description

($err, $numChildSnapshots) = SnapshotGetNumChildren($parentSnapshotHandle);

This function returns the number of child snapshots of a specified snapshot.

Parameters

parentSnapshotHandle: A snapshot handle.

Return Value

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

$numChildSnapshots. The number of child snapshots belonging to the specified snapshot.

Remarks

This function is not supported when using the VIX_SERVICEPROVIDER_VMWARE_PLAYER host type.

Side Effects

None.

Requirements

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

since VMware Workstation 6.0.

Example

my $parentSnapshot;
my $numChildren;
my $err;

($err, $numChildren) = SnapshotGetNumChildren($parentSnapshotHandle);
printf "the snapshot has %d child snapshots\n", numChildren;